IResourceProvider Class Reference

Inheritance diagram for IResourceProvider:

Collaboration diagram for IResourceProvider:

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

Detailed Description

An object that provides access to package resources

Definition at line 572 of file __init__.py.

Member Function Documentation

get_resource_filename()

get_resource_filename	(		manager,
			resource_name
	)

Return a true filesystem path for `resource_name`

`manager` must be an ``IResourceManager``

Definition at line 575 of file __init__.py.

    def get_resource_filename(manager, resource_name):
        """Return a true filesystem path for `resource_name`
 
        `manager` must be an ``IResourceManager``"""
 

get_resource_stream()

get_resource_stream	(		manager,
			resource_name
	)

Return a readable file-like object for `resource_name`

`manager` must be an ``IResourceManager``

Definition at line 580 of file __init__.py.

    def get_resource_stream(manager, resource_name):
        """Return a readable file-like object for `resource_name`
 
        `manager` must be an ``IResourceManager``"""
 

get_resource_string()

get_resource_string	(		manager,
			resource_name
	)

Return a string containing the contents of `resource_name`

`manager` must be an ``IResourceManager``

Definition at line 585 of file __init__.py.

    def get_resource_string(manager, resource_name):
        """Return a string containing the contents of `resource_name`
 
        `manager` must be an ``IResourceManager``"""
 

has_resource()

has_resource

(

resource_name

)

Does the package contain the named resource?

Definition at line 590 of file __init__.py.

    def has_resource(resource_name):
        """Does the package contain the named resource?"""
 

resource_isdir()

resource_isdir

(

resource_name

)

Is the named resource a directory?  (like ``os.path.isdir()``)

Definition at line 593 of file __init__.py.

    def resource_isdir(resource_name):
        """Is the named resource a directory?  (like ``os.path.isdir()``)"""
 

resource_listdir()

resource_listdir

(

resource_name

)

List of resource names in the directory (like ``os.listdir()``)

Definition at line 596 of file __init__.py.

    def resource_listdir(resource_name):
        """List of resource names in the directory (like ``os.listdir()``)"""
 
 

---

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