swh.storage.proxies.masking package

Submodules

• swh.storage.proxies.masking.cli module
  • storage_config_iter()
  • EditAborted
  • edit_message()
  • RequestType
    • RequestType.name
    • RequestType.convert()
  • SWHIDType
    • SWHIDType.name
    • SWHIDType.convert()
  • MaskedStateType
  • parse_masked_state()
  • format_masked_state()
  • read_swhids()
  • output_message()
• swh.storage.proxies.masking.db module
  • DuplicateRequest
  • RequestNotFound
  • MaskedState
    • MaskedState.VISIBLE
    • MaskedState.DECISION_PENDING
    • MaskedState.RESTRICTED
  • MaskedStatus
  • MaskingRequest
    • MaskingRequest.id
    • MaskingRequest.slug
    • MaskingRequest.date
    • MaskingRequest.reason
  • MaskingRequestHistory
    • MaskingRequestHistory.request
    • MaskingRequestHistory.date
    • MaskingRequestHistory.message
  • MaskedObject
  • DisplayName
    • DisplayName.original_email
    • DisplayName.display_name
  • MaskingDb
    • MaskingDb.current_version
  • MaskingAdmin
    • MaskingAdmin.create_request()
    • MaskingAdmin.find_request()
    • MaskingAdmin.find_request_by_id()
    • MaskingAdmin.get_requests()
    • MaskingAdmin.set_object_state()
    • MaskingAdmin.get_states_for_request()
    • MaskingAdmin.find_masks()
    • MaskingAdmin.delete_masks()
    • MaskingAdmin.record_history()
    • MaskingAdmin.set_display_name()
    • MaskingAdmin.get_history()
  • MaskingQuery
    • MaskingQuery.swhids_are_masked()
    • MaskingQuery.display_name()
    • MaskingQuery.iter_masked_swhids()

Module contents

swh.storage.proxies.masking.get_datastore(cls, db)

swh.storage.proxies.masking.masking_overhead_timer(method_name: str) → DifferentialTimer

Return a properly setup DifferentialTimer for method_name of the storage

class swh.storage.proxies.masking.MaskingProxyStorage(masking_db: str, storage: Dict | StorageInterface, min_pool_conns: int = 1, max_pool_conns: int = 5)

Bases: object

Masking storage proxy

This proxy filters out objects that are present in the archive but should not be displayed for policy reasons.

It uses a specific PostgreSQL database (which for now is colocated with the swh.storage PostgreSQL database), the access to which is implemented in the db submodule.

Sample configuration

content_get_data(content: HashDict | bytes) → bytes | None

RANDOM_ATTEMPTS = 5

TRevision = ~TRevision

TRelease = ~TRelease

revision_get(revision_ids: List[bytes], ignore_displayname: bool = False) → List[Revision | None]

revision_log(revisions: List[bytes], ignore_displayname: bool = False, limit: int | None = None) → Iterable[Dict[str, Any] | None]

revision_get_partition(partition_id: int, nb_partitions: int, page_token: str | None = None, limit: int = 1000) → PagedResult[Revision, str]

release_get(releases: List[bytes], ignore_displayname: bool = False) → List[Release | None]

release_get_partition(partition_id: int, nb_partitions: int, page_token: str | None = None, limit: int = 1000) → PagedResult[Release, str]