6481d27425
Put all public API in __all__, also put them all in pyspark.__init__.py, then we can got all the documents for public API by `pydoc pyspark`. It also can be used by other programs (such as Sphinx or Epydoc) to generate only documents for public APIs. Author: Davies Liu <davies.liu@gmail.com> Closes #2205 from davies/public and squashes the following commits: c6c5567 [Davies Liu] fix message f7b35be [Davies Liu] put SchemeRDD, Row in pyspark.sql module 7e3016a [Davies Liu] add __all__ in mllib 6281b48 [Davies Liu] fix doc for SchemaRDD 6caab21 [Davies Liu] add public interfaces into pyspark.__init__.py
60 lines
1.9 KiB
Python
60 lines
1.9 KiB
Python
#
|
|
# Licensed to the Apache Software Foundation (ASF) under one or more
|
|
# contributor license agreements. See the NOTICE file distributed with
|
|
# this work for additional information regarding copyright ownership.
|
|
# The ASF licenses this file to You under the Apache License, Version 2.0
|
|
# (the "License"); you may not use this file except in compliance with
|
|
# the License. You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
|
|
import os
|
|
|
|
|
|
__all__ = ['SparkFiles']
|
|
|
|
|
|
class SparkFiles(object):
|
|
|
|
"""
|
|
Resolves paths to files added through
|
|
L{SparkContext.addFile()<pyspark.context.SparkContext.addFile>}.
|
|
|
|
SparkFiles contains only classmethods; users should not create SparkFiles
|
|
instances.
|
|
"""
|
|
|
|
_root_directory = None
|
|
_is_running_on_worker = False
|
|
_sc = None
|
|
|
|
def __init__(self):
|
|
raise NotImplementedError("Do not construct SparkFiles objects")
|
|
|
|
@classmethod
|
|
def get(cls, filename):
|
|
"""
|
|
Get the absolute path of a file added through C{SparkContext.addFile()}.
|
|
"""
|
|
path = os.path.join(SparkFiles.getRootDirectory(), filename)
|
|
return os.path.abspath(path)
|
|
|
|
@classmethod
|
|
def getRootDirectory(cls):
|
|
"""
|
|
Get the root directory that contains files added through
|
|
C{SparkContext.addFile()}.
|
|
"""
|
|
if cls._is_running_on_worker:
|
|
return cls._root_directory
|
|
else:
|
|
# This will have to change if we support multiple SparkContexts:
|
|
return cls._sc._jvm.org.apache.spark.SparkFiles.getRootDirectory()
|