collecting_society package

Subpackages

Submodules

collecting_society.account module

collecting_society.account_invoice module

collecting_society.bank module

collecting_society.collecting_society module

collecting_society.configuration module

collecting_society.generators module

collecting_society.party module

collecting_society.setup module

collecting_society.web_user module

Module contents

collecting_society.AccessControlEntry[source]

alias of AccessControlEntry

collecting_society.AccessControlEntryRole[source]

alias of AccessControlEntryRole

class collecting_society.AccessControlList[source]

Bases: object

Mixin to add an Access Control List

acl

Define one2many field (list).

permissions(web_user, valid_codes=[], derive=True)[source]
permits(web_user, code, derive=True)[source]
collecting_society.AccessPermission[source]

alias of AccessPermission

collecting_society.AccessRole[source]

alias of AccessRole

collecting_society.AccessRolePermission[source]

alias of AccessRolePermission

collecting_society.Allocation[source]

alias of Allocation

collecting_society.AllocationAccountInvoice[source]

alias of AllocationAccountInvoice

collecting_society.AllocationInvoice[source]

alias of AllocationInvoice

collecting_society.Artist[source]

alias of Artist

collecting_society.ArtistArtist[source]

alias of ArtistArtist

collecting_society.ArtistIdentifier[source]

alias of ArtistIdentifier

collecting_society.ArtistIdentifierSpace[source]

alias of ArtistIdentifierSpace

collecting_society.ArtistPayeeAcceptance[source]

alias of ArtistPayeeAcceptance

collecting_society.ArtistPlaylist[source]

alias of ArtistPlaylist

collecting_society.ArtistPlaylistItem[source]

alias of ArtistPlaylistItem

collecting_society.ArtistRelease[source]

alias of ArtistRelease

collecting_society.Checksum[source]

alias of Checksum

class collecting_society.ClaimState[source]

Bases: object

Mixin for the claim workflow

claim_state

Define a selection field (str).

static default_claim_state()[source]
collecting_society.Collect[source]

alias of Collect

collecting_society.CollectStart[source]

alias of CollectStart

collecting_society.CollectingSociety[source]

alias of CollectingSociety

collecting_society.Collection[source]

alias of Collection

class collecting_society.CommitState[source]

Bases: object

Mixin for the commit workflow

commit_state

Define a selection field (str).

static default_commit_state()[source]
collecting_society.Content[source]

alias of Content

collecting_society.Creation[source]

alias of Creation

collecting_society.CreationContribution[source]

alias of CreationContribution

collecting_society.CreationContributionRole[source]

alias of CreationContributionRole

collecting_society.CreationDerivative[source]

alias of CreationDerivative

collecting_society.CreationIdentifier[source]

alias of CreationIdentifier

collecting_society.CreationIdentifierSpace[source]

alias of CreationIdentifierSpace

collecting_society.CreationRight[source]

alias of CreationRight

collecting_society.CreationRightCreationRight[source]

alias of CreationRightCreationRight

collecting_society.CreationRightInstrument[source]

alias of CreationRightInstrument

collecting_society.CreationRole[source]

alias of CreationRole

collecting_society.CreationTariffCategory[source]

alias of CreationTariffCategory

class collecting_society.CurrencyDigits[source]

Bases: object

Mixin to provide the currency digit configuration

currency_digits

Define function field (any).

get_currency_digits(name)[source]
collecting_society.Declaration[source]

alias of Declaration

collecting_society.DeclarationCollection[source]

alias of DeclarationCollection

collecting_society.DeclarationGroup[source]

alias of DeclarationGroup

collecting_society.Device[source]

alias of Device

collecting_society.DeviceAssignment[source]

alias of DeviceAssignment

collecting_society.DeviceMessage[source]

alias of DeviceMessage

collecting_society.DeviceMessageDeviceMessage[source]

alias of DeviceMessageDeviceMessage

collecting_society.DeviceMessageFingerprint[source]

alias of DeviceMessageFingerprint

collecting_society.DeviceMessageFingerprintCreationlist[source]

alias of DeviceMessageFingerprintCreationlist

collecting_society.DeviceMessageFingerprintCreationlistItem[source]

alias of DeviceMessageFingerprintCreationlistItem

collecting_society.DeviceMessageFingerprintMatch[source]

alias of DeviceMessageFingerprintMatch

collecting_society.DeviceMessageFingerprintMatchStart[source]

alias of DeviceMessageFingerprintMatchStart

collecting_society.DeviceMessageFingerprintMerge[source]

alias of DeviceMessageFingerprintMerge

collecting_society.DeviceMessageFingerprintMergeSelect[source]

alias of DeviceMessageFingerprintMergeSelect

collecting_society.DeviceMessageFingerprintMergeStart[source]

alias of DeviceMessageFingerprintMergeStart

collecting_society.DeviceMessageUsagereport[source]

alias of DeviceMessageUsagereport

collecting_society.Distribute[source]

alias of Distribute

collecting_society.DistributeStart[source]

alias of DistributeStart

collecting_society.Distribution[source]

alias of Distribution

collecting_society.DistributionPlan[source]

alias of DistributionPlan

class collecting_society.EntityOrigin[source]

Bases: object

Mixin to track the origin of the entity

static default_entity_origin()[source]
entity_creator

Define many2one field (int).

entity_origin

Define a selection field (str).

collecting_society.Event[source]

alias of Event

collecting_society.EventIndicators[source]

alias of EventIndicators

collecting_society.EventPerformance[source]

alias of EventPerformance

collecting_society.Filesystem[source]

alias of Filesystem

collecting_society.FilesystemLabel[source]

alias of FilesystemLabel

collecting_society.Fingerprintlog[source]

alias of Fingerprintlog

collecting_society.Genre[source]

alias of Genre

collecting_society.Harddisk[source]

alias of Harddisk

collecting_society.HarddiskLabel[source]

alias of HarddiskLabel

collecting_society.HarddiskTest[source]

alias of HarddiskTest

class collecting_society.IndicatorsMeta(measured_class_name, bases, dct)[source]

Bases: ModelMeta

Metaclass for models to be measured by indicators.

Measured models are models of real world objects to be measured by a set of attributes. Indicators are models containing the set of attributes. Each measured model is expected to have exactly one corresponding indicator model and may refer to several samples of this indicator model.

This metaclass prepares measured models to be used with indicators by:

  • adding Many2One fields to the measured model for each sample

  • adding One2Many fields to the indicators model for each sample

  • adding getter/setter for all indicator attributes in the measured model

  • autocreating the relations to the indicators in the measured model

To add this metaclass to a measured model, it needs to have set:

class ModelName(metaclass=IndicatorsMeta) __indicators__ = <INDICATORS_MODEL_NAME> __samples__ = [<SAMPLE_NAME_1>, <SAMPLE_NAME_2>]

Example

Events(metaclass=IndicatorsMeta) __indicators__ = ‘events.indicators’ __samples__ = [‘estimated’, ‘confirmed’]

If the indicator model would include one field ‘size’ and the samples would be ‘estimated’ and ‘confirmed’, the attributes would be accesible via estimated_size and confirmed_size in the measured model. The indicators are accessible via estimated_indicators and confirmed_indicators.

Changes to the measured model:

  • Adds fields for the indicators for each sample

    • [fields.Many2One] <SAMPLE_NAME>_indicators

  • Adds create/copy classmethods to autocreate the indicators objects

    • [classmethod] create

    • [classmethod] copy

  • Adds shortcut function fields with setter/getter for indicator attributes

    • [fields.Function] <SAMPLE_NAME>_<ATTRIBUTE_NAME>

    • [method] get_<SAMPLE_NAME>_<ATTRIBUTE_NAME>

    • [method] set_<SAMPLE_NAME>_<ATTRIBUTE_NAME>

  • Adds original field name in shortcut fields to ease later access:

    • [string] estimated_<ATTRIBUTE_NAME>._attribute_name

    • [string] confirmed_<ATTRIBUTE_NAME>._attribute_name

Changes to the indicators model: - Adds back reference field to the measured for each sample

  • [fields.One2Many] <SAMPLE_NAME>_<MEASURED_MODEL_NAME>

Note: The class name of the indicator model is expected to be the capitalized model name without dots.

static copy(samples)[source]

This create method wraps the create method of the measured class

static create(indicators_model_name, samples)[source]

This copy method wraps the copy method of the measured class

static get_attribute(sample_name)[source]
static search_attribute(sample_name)[source]
static set_attribute(sample_name)[source]
collecting_society.Instrument[source]

alias of Instrument

collecting_society.Label[source]

alias of Label

collecting_society.License[source]

alias of License

collecting_society.Location[source]

alias of Location

collecting_society.LocationCategory[source]

alias of LocationCategory

collecting_society.LocationIndicators[source]

alias of LocationIndicators

collecting_society.LocationIndicatorsPeriod[source]

alias of LocationIndicatorsPeriod

collecting_society.LocationSpace[source]

alias of LocationSpace

collecting_society.LocationSpaceCategory[source]

alias of LocationSpaceCategory

collecting_society.LocationSpaceIndicators[source]

alias of LocationSpaceIndicators

class collecting_society.MixinIdentifier[source]

Bases: object

Mixin for <Object>Identifier models

id_code

Define a char field (unicode).

valid_from

Define a date field (date).

valid_to

Define a date field (date).

class collecting_society.MixinRight[source]

Bases: object

Mixin for the right a rightsholder claims on an rights object

collecting_society

Define many2one field (int).

property contribution
country

Define many2one field (int).

property predecessor
property rightsholder
property rightsobject
property successor
type_of_right

Define a selection field (str).

valid_from

Define a date field (date).

valid_to

Define a date field (date).

class collecting_society.PublicApi[source]

Bases: object

Mixin to add an unique identifier for public use

static default_oid()[source]
oid

Define a char field (unicode).

collecting_society.Publisher[source]

alias of Publisher

collecting_society.Release[source]

alias of Release

collecting_society.ReleaseGenre[source]

alias of ReleaseGenre

collecting_society.ReleaseIdentifier[source]

alias of ReleaseIdentifier

collecting_society.ReleaseIdentifierSpace[source]

alias of ReleaseIdentifierSpace

collecting_society.ReleaseIndicators[source]

alias of ReleaseIndicators

collecting_society.ReleaseRight[source]

alias of ReleaseRight

collecting_society.ReleaseRightReleaseRight[source]

alias of ReleaseRightReleaseRight

collecting_society.ReleaseStyle[source]

alias of ReleaseStyle

collecting_society.ReleaseTrack[source]

alias of ReleaseTrack

collecting_society.Storehouse[source]

alias of Storehouse

collecting_society.Style[source]

alias of Style

collecting_society.Tariff[source]

alias of Tariff

collecting_society.TariffAdjustment[source]

alias of TariffAdjustment

collecting_society.TariffAdjustmentCategory[source]

alias of TariffAdjustmentCategory

collecting_society.TariffCategory[source]

alias of TariffCategory

collecting_society.TariffCategoryTariffAdjustmentCategory[source]

alias of TariffCategoryTariffAdjustmentCategory

collecting_society.TariffCategoryTariffRelevanceCategory[source]

alias of TariffCategoryTariffRelevanceCategory

collecting_society.TariffRelevance[source]

alias of TariffRelevance

collecting_society.TariffRelevanceCategory[source]

alias of TariffRelevanceCategory

collecting_society.TariffSystem[source]

alias of TariffSystem

collecting_society.Utilisation[source]

alias of Utilisation

collecting_society.UtilisationCreationlist[source]

alias of UtilisationCreationlist

collecting_society.UtilisationCreationlistItem[source]

alias of UtilisationCreationlistItem

collecting_society.UtilisationIndicators[source]

alias of UtilisationIndicators

collecting_society.Website[source]

alias of Website

collecting_society.WebsiteCategory[source]

alias of WebsiteCategory

collecting_society.WebsiteCategoryWebsiteResourceCategory[source]

alias of WebsiteCategoryWebsiteResourceCategory

collecting_society.WebsiteResource[source]

alias of WebsiteResource

collecting_society.WebsiteResourceCategory[source]

alias of WebsiteResourceCategory

collecting_society.WebsiteResourceCreation[source]

alias of WebsiteResourceCreation

collecting_society.WebsiteResourceIndicators[source]

alias of WebsiteResourceIndicators