FileMetadata Class Reference

Inheritance diagram for FileMetadata:

Collaboration diagram for FileMetadata:

Public Member Functions
	__init__ (self, path)
	has_metadata (self, name)
	get_metadata (self, name)
	get_metadata_lines (self, name)
Public Member Functions inherited from NullProvider
	get_resource_filename (self, manager, resource_name)
	get_resource_stream (self, manager, resource_name)
	get_resource_string (self, manager, resource_name)
	has_resource (self, resource_name)
	resource_isdir (self, resource_name)
	metadata_isdir (self, name)
	resource_listdir (self, resource_name)
	metadata_listdir (self, name)
	run_script (self, script_name, namespace)

Data Fields
	path
Data Fields inherited from NullProvider
	module_path

Protected Member Functions
	_get_metadata_path (self, name)
	_warn_on_replacement (self, metadata)
Protected Member Functions inherited from EmptyProvider
	_get (self, path)
	_listdir (self, path)
Protected Member Functions inherited from NullProvider
	_has (self, path)
	_isdir (self, path)
	_fn (self, base, resource_name)

Additional Inherited Members
Static Public Attributes inherited from EmptyProvider
	module_path = None
Static Public Attributes inherited from NullProvider
	egg_name = None
	egg_info = None
	loader = None
Static Protected Member Functions inherited from NullProvider
	_validate_resource_path (path)
Static Protected Attributes inherited from EmptyProvider
False	_isdir = lambda self, path

Detailed Description

Metadata handler for standalone PKG-INFO files

Usage::

    metadata = FileMetadata("/path/to/PKG-INFO")

This provider rejects all data and metadata requests except for PKG-INFO,
which is treated as existing, and will be the contents of the file at
the provided location.

Definition at line 1979 of file __init__.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			path
	)

Reimplemented from EmptyProvider.

Definition at line 1991 of file __init__.py.

    def __init__(self, path):
        self.path = path
 

Referenced by Protocol.__init_subclass__().

Here is the caller graph for this function:

Member Function Documentation

_get_metadata_path()

_get_metadata_path (   self,   name  )

protected

Reimplemented from NullProvider.

Definition at line 1994 of file __init__.py.

    def _get_metadata_path(self, name):
        return self.path
 

_warn_on_replacement()

_warn_on_replacement (   self,   metadata  )

protected

Definition at line 2009 of file __init__.py.

    def _warn_on_replacement(self, metadata):
        replacement_char = '�'
        if replacement_char in metadata:
            tmpl = "{self.path} could not be properly decoded in UTF-8"
            msg = tmpl.format(**locals())
            warnings.warn(msg)
 

get_metadata()

get_metadata	(		self,
			name
	)

Reimplemented from NullProvider.

Definition at line 2000 of file __init__.py.

    def get_metadata(self, name):
        if name != 'PKG-INFO':
            raise KeyError("No metadata except PKG-INFO is available")
 
        with io.open(self.path, encoding='utf-8', errors="replace") as f:
            metadata = f.read()
        self._warn_on_replacement(metadata)
        return metadata
 

Referenced by InMemoryMetadata.get_metadata_lines().

Here is the caller graph for this function:

get_metadata_lines()

get_metadata_lines	(		self,
			name
	)

Reimplemented from NullProvider.

Definition at line 2016 of file __init__.py.

    def get_metadata_lines(self, name):
        return yield_lines(self.get_metadata(name))
 
 

has_metadata()

has_metadata	(		self,
			name
	)

Reimplemented from NullProvider.

Definition at line 1997 of file __init__.py.

    def has_metadata(self, name):
        return name == 'PKG-INFO' and os.path.isfile(self.path)
 

Field Documentation

path

path

Definition at line 1992 of file __init__.py.

Referenced by InstalledDistribution.__eq__(), EggInfoDistribution.__eq__(), DistributionPath._yield_distributions(), _Cache.add(), InstalledDistribution.check_installed_files(), EggInfoDistribution.check_installed_files(), _Cache.clear(), Link.filename(), InstalledDistribution.get_distinfo_file(), InstalledDistribution.get_distinfo_resource(), InstalledDistribution.list_distinfo_files(), EggInfoDistribution.list_distinfo_files(), EggInfoDistribution.list_installed_files(), Url.request_uri(), InstalledDistribution.shared_locations(), Link.splitext(), InstalledDistribution.write_installed_files(), and InstalledDistribution.write_shared_locations().

---

The documentation for this class was generated from the following file:

• /home/liwuen/projects_dev/pqc-engineering-ssec-23/venv/lib/python3.12/site-packages/pip/_vendor/pkg_resources/__init__.py