`arelle.ModelVersReport`¶

See COPYRIGHT.md for copyright information.

Module Contents¶

Classes¶

ModelVersReport

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

Functions¶

create

Returns a new modelXbrl representing a Version Report object, by creation of its modelXbrl, its ModelVersReport (modelDocument), and diffing the from and to DTSes

Data¶

`relationshipSetArcAttributesExclusion`
`authoritiesEquivalence`
`dateRemovalPattern`
`numberRemovalPattern`

API¶

arelle.ModelVersReport.create(modelXbrlFromDTS, modelXbrlToDTS)¶

Returns a new modelXbrl representing a Version Report object, by creation of its modelXbrl, its ModelVersReport (modelDocument), and diffing the from and to DTSes

Parameters:

modelXbrlFromDTS (ModelXbrl) – fromDTS DTS object
modelXbrlToDTS (ModelXbrl) – toDTS DTS object

arelle.ModelVersReport.relationshipSetArcAttributesExclusion¶: None

arelle.ModelVersReport.authoritiesEquivalence¶: None

arelle.ModelVersReport.dateRemovalPattern¶: ‘compile(…)’

arelle.ModelVersReport.numberRemovalPattern¶: ‘compile(…)’

class arelle.ModelVersReport.ModelVersReport(modelXbrl, type=ModelDocument.Type.VERSIONINGREPORT, uri=None, filepath=None, xmlDocument=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, **kwargs)¶: Closes any views, formula output instances, modelDocument(s), and dereferences all memory used

versioningReportDiscover(rootElement)¶

Initiates discovery of versioning report

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

entryURIs(DTS)¶

diffDTSes(reportOutput, fromDTS, toDTS, assignment='technical', schemaDir=None)¶

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