setuptools.command.sdist.sdist

class documentation

class sdist(sdist_add_defaults, orig.sdist): (source)

Known subclasses: setuptools.command.egg_info.manifest_maker

View In Hierarchy

Smart sdist that finds anything supported by revision control

Method add_defaults Undocumented
Method check_readme Undocumented
Method initialize_options Undocumented
Method make_distribution Workaround for #516
Method make_release_tree Undocumented
Method read_manifest Read the manifest file (named by 'self.manifest') and use it to fill in 'self.filelist', the list of files to include in the source distribution.
Method run Undocumented
Constant README_EXTENSIONS Undocumented
Constant READMES Undocumented
Class Variable negative_opt Undocumented
Class Variable user_options Undocumented
Instance Variable filelist Undocumented
Instance Variable formats Undocumented
Static Method _remove_os_link In a context, remove and restore os.link if it exists
Method _add_data_files Add data files as found in build_py.data_files.
Method _add_defaults_build_sub_commands Undocumented
Method _add_defaults_data_files Undocumented
Method _add_defaults_optional Undocumented
Method _add_defaults_python getting python files
Method _default_to_gztar Undocumented
Method _manifest_is_not_generated Undocumented
Method _safe_data_files Since the ``sdist`` class is also used to compute the MANIFEST (via :obj:`setuptools.command.egg_info.manifest_maker`), there might be recursion problems when trying to obtain the list of data_files and ``include_package_data=True`` (which in turn depends on the files included in the MANIFEST).
def add_defaults(self): (source)
overridden in setuptools.command.egg_info.manifest_maker

Undocumented

def check_readme(self): (source)

Undocumented

def initialize_options(self): (source)
overridden in setuptools.command.egg_info.manifest_maker

Undocumented

def make_distribution(self): (source)

Workaround for #516

def make_release_tree(self, base_dir, files): (source)

Undocumented

def read_manifest(self): (source)

Read the manifest file (named by 'self.manifest') and use it to fill in 'self.filelist', the list of files to include in the source distribution.

def run(self): (source)
overridden in setuptools.command.egg_info.manifest_maker

Undocumented

README_EXTENSIONS: list[str] = (source)

Undocumented

Value
['', '.rst', '.txt', '.md']
READMES = (source)

Undocumented

Value
tuple(('README{0}'.format(ext) for ext in README_EXTENSIONS))
negative_opt: dict = (source)

Undocumented

user_options = (source)

Undocumented

filelist = (source)
overridden in setuptools.command.egg_info.manifest_maker

Undocumented

formats: list[str] = (source)

Undocumented

@staticmethod
@contextlib.contextmanager
def _remove_os_link(): (source)

In a context, remove and restore os.link if it exists

def _add_data_files(self, data_files): (source)

Add data files as found in build_py.data_files.

def _add_defaults_build_sub_commands(self): (source)

Undocumented

def _add_defaults_data_files(self): (source)

Undocumented

def _add_defaults_optional(self): (source)

Undocumented

def _add_defaults_python(self): (source)

getting python files

def _default_to_gztar(self): (source)

Undocumented

def _manifest_is_not_generated(self): (source)

Undocumented

def _safe_data_files(self, build_py): (source)
overridden in setuptools.command.egg_info.manifest_maker

Since the ``sdist`` class is also used to compute the MANIFEST (via :obj:`setuptools.command.egg_info.manifest_maker`), there might be recursion problems when trying to obtain the list of data_files and ``include_package_data=True`` (which in turn depends on the files included in the MANIFEST). To avoid that, ``manifest_maker`` should be able to overwrite this method and avoid recursive attempts to build/analyze the MANIFEST.