blackfennec.document_system.resource_type package

Subpackages

Submodules

blackfennec.document_system.resource_type.resource_type module

class blackfennec.document_system.resource_type.resource_type.ResourceType[source]

Bases: object

guess_mime_type(uri: str) → Optional[str][source]
abstract load_resource(document: Document, mode: str) → IO[source]

Load the resource

Parameters

  • document (Document) – document to load

  • mode (str) – the file open mode to use

Returns

loaded resource

Return type

IO

Raises

NotImplementedError – if subclass did not implement this method

abstract property protocols: List[str]

List of protocols supported by Resource Type

Returns

protocols supported

Return type

List[str]

Raises

NotImplementedError – if subclass did not implement this property

static try_determine_resource_type(resource_uri: str) → str[source]

blackfennec.document_system.resource_type.resource_type_registry module

class blackfennec.document_system.resource_type.resource_type_registry.ResourceTypeRegistry[source]

Bases: object

ResourceType Registry Class

Is a register of all registered resource_types.

_resource_types

stores internal resource_types

deregister_resource_type(resource_type_id)[source]
Function to deregister a resource_type from the registry if its class

matches the passed type

Parameters

resource_type_id (str) – key in the resource_type dict

register_resource_type(resource_type_id: str, resource_type: ResourceType)[source]

Function to register a new resource_type

Parameters

  • resource_type_id (str) – Key at which the ResourceType is to be inserted

  • resource_type (ResourceType) – future element of the resource_type registry

property resource_types

resource_types getter

Returns

of resource_type

Return type

dict

Module contents