setuptools.config.setupcfg.ConfigMetadataHandler

class documentation

class ConfigMetadataHandler(ConfigHandler['DistributionMetadata']): (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Class Variable aliases Options aliases. For compatibility with various packages. E.g.: d2to1 and pbr. Note: `-` in keys is replaced with `_` by config parser.
Class Variable section_prefix Prefix for config sections handled by this handler. Must be provided by class heirs.
Class Variable strict_mode We need to keep it loose, to be partially compatible with `pbr` and `d2to1` packages which also uses `metadata` section.
Instance Variable package_dir Undocumented
Instance Variable root_dir Undocumented
Property parsers Metadata item name to parser function mapping.
Method _parse_version Parses `version` option value.

Inherited from ConfigHandler:

Method __setitem__ Undocumented
Method parse Parses configuration file items from one or more related sections.
Method parse_section Parses configuration file section.
Instance Variable ensure_discovered Undocumented
Instance Variable ignore_option_errors Undocumented
Instance Variable sections Undocumented
Instance Variable set_options Undocumented
Instance Variable target_obj Undocumented
Class Method _exclude_files_parser Returns a parser function to make sure field inputs are not files.
Class Method _get_parser_compound Returns parser function to represents value as a list.
Class Method _parse_bool Represents value as boolean.
Class Method _parse_dict Represents value as a dict.
Class Method _parse_list Represents value as a list.
Class Method _parse_section_to_dict Parses section options into a dictionary.
Class Method _parse_section_to_dict_with_key Parses section options into a dictionary.
Class Method _section_options Undocumented
Method _deprecated_config_handler this function will wrap around parameters that are deprecated
Method _parse_attr Represents value as a module attribute.
Method _parse_file Represents value as a string, allowing including text from nearest files using `file:` directive.
Instance Variable _referenced_files After parsing configurations, this property will enumerate all files referenced by the "file:" directive. Private API for setuptools only.
def __init__(self, target_obj: DistributionMetadata, options: AllCommandOptions, ignore_option_errors: bool, ensure_discovered: expand.EnsurePackagesDiscovered, package_dir: Optional[dict] = None, root_dir: _Path = os.curdir): (source)
overrides setuptools.config.setupcfg.ConfigHandler.__init__

Undocumented

aliases: dict[str, str] = (source)
overrides setuptools.config.setupcfg.ConfigHandler.aliases

Options aliases. For compatibility with various packages. E.g.: d2to1 and pbr. Note: `-` in keys is replaced with `_` by config parser.

section_prefix: str = (source)
overrides setuptools.config.setupcfg.ConfigHandler.section_prefix

Prefix for config sections handled by this handler. Must be provided by class heirs.

strict_mode: bool = (source)

We need to keep it loose, to be partially compatible with `pbr` and `d2to1` packages which also uses `metadata` section.

package_dir = (source)

Undocumented

root_dir = (source)

Undocumented

@property
parsers = (source)
overrides setuptools.config.setupcfg.ConfigHandler.parsers

Metadata item name to parser function mapping.

def _parse_version(self, value): (source)

Parses `version` option value. :param value: :rtype: str