arelle.ModelVersReport

See COPYRIGHT.md for copyright information.

Module Contents

Classes

ModelVersReport

.. class:: ModelVersReport(type=ModelDocument.Type.VERSIONINGREPORT, uri=None, filepath=None, xmlDocument=None)

Data

relationshipSetArcAttributesExclusion

authoritiesEquivalence

dateRemovalPattern

numberRemovalPattern

API

arelle.ModelVersReport.relationshipSetArcAttributesExclusion

None

arelle.ModelVersReport.authoritiesEquivalence

None

arelle.ModelVersReport.dateRemovalPattern

‘compile(…)’

arelle.ModelVersReport.numberRemovalPattern

‘compile(…)’

class arelle.ModelVersReport.ModelVersReport(modelXbrl: arelle.ModelXbrl.ModelXbrl, type: int = ModelDocument.Type.VERSIONINGREPORT, uri: str = '', filepath: str = '', xmlDocument: lxml.etree._ElementTree[lxml.etree._Element] | None = None)

Bases: arelle.ModelDocument.ModelDocument

.. class:: ModelVersReport(type=ModelDocument.Type.VERSIONINGREPORT, uri=None, filepath=None, xmlDocument=None)

ModelVersReport is a specialization of ModelDocument for Versioning Reports.

(for parameters and inherited attributes, please see ModelDocument)

.. attribute:: fromDTS

From DTS (modelXbrl object)

.. attribute:: toDTS

To DTS (modelXbrl object)

.. attribute:: assignments

Dict by id of ModelAssignment objects

.. attribute:: actions

Dict by id of ModelAction objects

.. attribute:: namespaceRenameFrom

Dict by fromURI of ModelNamespaceRename objects

.. attribute:: namespaceRenameTo

Dict  by toURI of ModelNamespaceRename objects

.. attribute:: roleChanges

Dict by uri of ModelRoleChange objects

.. attribute:: conceptUseChanges

List of ModelConceptUseChange objects

.. attribute:: conceptDetailsChanges

List of ModelConceptDetailsChange objects

.. attribute:: equivalentConcepts

Dict by qname of equivalent qname

.. attribute:: relatedConceptsDefaultDict by qname of list of related concept qnames


.. attribute:: relationshipSetChanges    List of ModelRelationshipSet objects

.. attribute:: instanceAspectChanges

List of ModelInstanceAspectChange objects

.. attribute:: typedDomainsCorrespond

Dict by (fromDimConcept,toDimConcept) of bool that is True if corresponding

Initialization

close(*args: Any, **kwargs: Any) → None

Closes any views, formula output instances, modelDocument(s), and dereferences all memory used

versioningReportDiscover(rootElement: arelle.ModelObject.ModelObject) → None

Initiates discovery of versioning report

Parameters:

rootElement (xml element node) – lxml root element of versioning report

entryURIs(DTS: arelle.ModelXbrl.ModelXbrl) → list[str]
diffDTSes(reportOutput: str | arelle.FileSource.FileNamedStringIO, fromDTS: arelle.ModelXbrl.ModelXbrl, toDTS: arelle.ModelXbrl.ModelXbrl, assignment: str = 'technical', schemaDir: str | None = None) → None

Initiates diffing of fromDTS and toDTS, populating the ModelVersReport object, and saving the versioning report file).

Parameters:

  • versReporFile (str) – file name to save the versioning report

  • fromDTS (ModelXbrl) – first modelXbrl’s (DTSes) to be diffed

  • toDTS (ModelXbrl) – second modelXbrl’s (DTSes) to be diffed

  • assignment (str) – ‘technical’, ‘business’, etc. for the assignment clause

  • schemaDir (str) – Directory for determination of relative path for versioning xsd files (versioning-base.xsd, etc).

diffNamespaces() → None
diffRoles() → None
diffURIs(fromURIs: set[str], toURIs: set[str], eventName: str, matchers: collections.abc.Iterable[collections.abc.Callable[[str], str]], changeFrom: dict[str, str], changeTo: dict[str, str]) → None
uriNumlessMatchPattern(uri: str) → str
roleNumlessMatchPattern(role: str) → str
rolePathlessDatelessMatchPattern(role: str) → str
roleNoFromToMatchPattern(role: str) → str
diffConcepts() → None
diffRelationshipSet(arcrole: str) → None
diffRelationships(fromConcept: arelle.ModelObject.ModelObject | None, toConcept: arelle.ModelObject.ModelObject | None, fromRelationshipSet: arelle.ModelRelationshipSet.ModelRelationshipSet, toRelationshipSet: arelle.ModelRelationshipSet.ModelRelationshipSet) → None
diffDimensionDefaults() → None
diffDimensions() → None
DRSdimRels(dts: arelle.ModelXbrl.ModelXbrl, priItemDRSrels: list[arelle.ModelDtsObject.ModelRelationship]) → list[tuple[arelle.ModelDtsObject.ModelRelationship, bool, bool]]
DRSdomRels(dts: arelle.ModelXbrl.ModelXbrl, dimRel: arelle.ModelDtsObject.ModelRelationship) → list[arelle.ModelDtsObject.ModelRelationship]
DRSdiff(fromConcept: arelle.ModelObject.ModelObject, fromLinkrole: str | None, toConcept: arelle.ModelObject.ModelObject, toLinkrole: str | None, arcrole: str, diffs: list[tuple[arelle.ModelDtsObject.ModelRelationship | None, arelle.ModelDtsObject.ModelRelationship | None, set[tuple[tuple[arelle.ModelValue.QName, Any], ...]], set[tuple[tuple[arelle.ModelValue.QName, Any], ...]]]] | None = None) → list[tuple[arelle.ModelDtsObject.ModelRelationship | None, arelle.ModelDtsObject.ModelRelationship | None, set[tuple[tuple[arelle.ModelValue.QName, Any], ...]], set[tuple[tuple[arelle.ModelValue.QName, Any], ...]]]]
DRShcDiff(fromDTS: arelle.ModelXbrl.ModelXbrl, fromPriItemDRSrels: list[arelle.ModelDtsObject.ModelRelationship], toDTS: arelle.ModelXbrl.ModelXbrl, toPriItemDRSrels: list[arelle.ModelDtsObject.ModelRelationship]) → list[tuple[arelle.ModelDtsObject.ModelRelationship | None, arelle.ModelDtsObject.ModelRelationship | None, set[tuple[tuple[arelle.ModelValue.QName, Any], ...]], set[tuple[tuple[arelle.ModelValue.QName, Any], ...]]]]
typedDomainIsDifferent(fromDimConcept: arelle.ModelDtsObject.ModelConcept, toDimConcept: arelle.ModelDtsObject.ModelConcept) → bool
typedDomainElementComment(dimConcept: arelle.ModelDtsObject.ModelConcept) → str | None
DRSdimsDiff(fromDTS: arelle.ModelXbrl.ModelXbrl, fromPriItemDRSrels: list[arelle.ModelDtsObject.ModelRelationship], toDTS: arelle.ModelXbrl.ModelXbrl, toPriItemDRSrels: list[arelle.ModelDtsObject.ModelRelationship]) → list[tuple[arelle.ModelDtsObject.ModelRelationship | None, arelle.ModelDtsObject.ModelRelationship | None, bool, list[tuple[arelle.ModelDtsObject.ModelRelationship | None, arelle.ModelDtsObject.ModelRelationship | None, set[tuple[tuple[arelle.ModelValue.QName, Any], ...]], set[tuple[tuple[arelle.ModelValue.QName, Any], ...]]]]]]
toDTSqname(fromDTSqname: arelle.ModelValue.QName | None) → arelle.ModelValue.QName | None
fromDTSqname(toDTSqname: arelle.ModelValue.QName | None) → arelle.ModelValue.QName | None
createAction() → arelle.ModelObject.ModelObject
createBaseEvent(eventName: str, fromURI: str, toURI: str) → None
createConceptEvent(eventNS: str, eventName: str, fromConcept: arelle.ModelDtsObject.ModelConcept | None = None, toConcept: arelle.ModelDtsObject.ModelConcept | None = None, action: arelle.ModelObject.ModelObject | None = None, fromCustomAttribute: arelle.ModelValue.QName | None = None, toCustomAttribute: arelle.ModelValue.QName | None = None, fromResource: arelle.ModelObject.ModelObject | None = None, toResource: arelle.ModelObject.ModelObject | None = None, fromValue: str | None = None, toValue: str | None = None, fromResourceText: str | None = None, toResourceText: str | None = None) → arelle.ModelObject.ModelObject
conceptHref(concept: arelle.ModelObject.ModelObject) → str
createRelationshipSetEvent(eventName: str, linkrole: str | tuple[str, ...] | None = None, arcrole: str | tuple[str, ...] | None = None, fromConcept: arelle.ModelObject.ModelObject | None = None, toConcept: arelle.ModelObject.ModelObject | None = None, axis: str | None = None, attrValues: collections.abc.Iterable[str] | None = None, comment: str | None = None, eventParent: arelle.ModelObject.ModelObject | None = None) → arelle.ModelObject.ModelObject
createInstanceAspectsEvent(eventName: str, eventAttributes: list[tuple[str, str | tuple[str, ...] | arelle.ModelValue.QName]] | None = None, comment: str | None = None, eventParent: arelle.ModelObject.ModelObject | None = None) → arelle.ModelObject.ModelObject