arelle.ModelVersReport
#
See COPYRIGHT.md for copyright information.
Module Contents#
Classes#
.. class:: ModelVersReport(type=ModelDocument.Type.VERSIONINGREPORT, uri=None, filepath=None, xmlDocument=None) |
Functions#
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#
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
- arelle.ModelVersReport.relationshipSetArcAttributesExclusion#
None
- arelle.ModelVersReport.authoritiesEquivalence#
None
- arelle.ModelVersReport.dateRemovalPattern#
None
- arelle.ModelVersReport.numberRemovalPattern#
None
- 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).
- 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()#
- diffRoles()#
- diffURIs(fromURIs, toURIs, eventName, matchers, changeFrom, changeTo)#
- uriNumlessMatchPattern(uri)#
- roleNumlessMatchPattern(role)#
- rolePathlessDatelessMatchPattern(role)#
- roleNoFromToMatchPattern(role)#
- diffConcepts()#
- diffRelationshipSet(arcrole)#
- diffRelationships(fromConcept, toConcept, fromRelationshipSet, toRelationshipSet)#
- diffDimensionDefaults()#
- diffDimensions()#
- DRSdimRels(dts, priItemDRSrels)#
- DRSdomRels(dts, dimRel)#
- DRSdiff(fromConcept, fromLinkrole, toConcept, toLinkrole, arcrole, diffs=None)#
- DRShcDiff(fromDTS, fromPriItemDRSrels, toDTS, toPriItemDRSrels)#
- typedDomainIsDifferent(fromDimConcept, toDimConcept)#
- typedDomainElementComment(dimConcept)#
- DRSdimsDiff(fromDTS, fromPriItemDRSrels, toDTS, toPriItemDRSrels)#
- toDTSqname(fromDTSqname)#
- fromDTSqname(toDTSqname)#
- createAction()#
- createBaseEvent(eventName, fromURI, toURI)#
- createConceptEvent(eventNS, eventName, fromConcept=None, toConcept=None, action=None, fromCustomAttribute=None, toCustomAttribute=None, fromResource=None, toResource=None, fromValue=None, toValue=None, fromResourceText=None, toResourceText=None)#
- conceptHref(concept)#
- createRelationshipSetEvent(eventName, linkrole=None, arcrole=None, fromConcept=None, toConcept=None, axis=None, attrValues=None, comment=None, eventParent=None)#
- createInstanceAspectsEvent(eventName, eventAttributes=None, comment=None, eventParent=None)#