arelle.ModelRssObject

See COPYRIGHT.md for copyright information.

Module Contents

Classes

ModelRssObject

.. class:: ModelRssObject(type=ModelDocument.Type.RSSFEED, uri=None, filepath=None, xmlDocument=None)

API

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

Bases: arelle.ModelDocument.ModelDocument

.. class:: ModelRssObject(type=ModelDocument.Type.RSSFEED, uri=None, filepath=None, xmlDocument=None)

ModelRssObject is a specialization of ModelDocument for RSS Feeds.

(for parameters and inherited attributes, please see ModelDocument)

Initialization

rssItems: list[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]

None

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

Initiates discovery of RSS feed

documentEncoding: str

None

entrypoint: dict[str, Any] | None

None

xmlRootElement: Any

None

targetXbrlRootElement: arelle.ModelObject.ModelObject

None

parser: lxml.etree.XMLParser[lxml.etree._Element]

None

parserLookupName: arelle.ModelObjectFactory.KnownNamespacesModelObjectClassLookup

None

parserLookupClass: arelle.ModelObjectFactory.DiscoveringClassLookup

None

securityClassification: str | None

None

fromDTS: arelle.ModelXbrl.ModelXbrl

None

toDTS: arelle.ModelXbrl.ModelXbrl

None

objectId(refId: str = '') → str

property qname: arelle.ModelValue.QName | None

relativeUri(uri: str) → str

property modelDocument: typing_extensions.Self

property displayUri: str

property basename: str

property filepathdir: str

property propertyView: tuple[tuple[str, str], ...]

setTitle(cntlr: arelle.CntlrWinMain.CntlrWinMain) → None

setTitleInBackground() → None

updateFileHistoryIfNeeded() → None

save(overrideFilepath: str | None = None, outputZip: zipfile.ZipFile | None = None, outputFile: io.IOBase | None = None, updateFileHistory: bool = True, encoding: str = 'utf-8', zipDir: str | None = None, **kwargs: Any) → None

close(visited: list[arelle.ModelDocument.ModelDocument] | None = None, urlDocs: dict[str, arelle.ModelDocument.ModelDocument] | None = None) → None

gettype() → str

property creationSoftwareComment: str | None

property creationSoftware: str

creationSoftwareMatches(text: str | None) → list[str]

property processingInstructions: list[lxml.etree._ProcessingInstruction]

schemaDiscover(rootElement: arelle.ModelObject.ModelObject, isIncluded: bool | None, isSupplemental: bool, namespace: str | None) → None

schemaDiscoverChildElements(parentModelObject: arelle.ModelObject.ModelObject, isSupplemental: bool = False) → None

baseForElement(element: arelle.ModelObject.ModelObject) → str

importDiscover(element: arelle.ModelObject.ModelObject) → None

schemalocateElementNamespace(element: arelle.ModelObject.ModelObject) → None

loadSchemalocatedSchemas() → None

schemaLinkbaseRefsDiscover(tree: arelle.ModelObject.ModelObject) → None

schemaLinkbaseRefDiscover(element: arelle.ModelObject.ModelObject) → Any

linkbasesDiscover(tree: arelle.ModelObject.ModelObject) → None

linkbaseDiscover(linkbaseElement: arelle.ModelObject.ModelObject, inInstance: bool = False) → None

discoverHref(element: arelle.ModelObject.ModelObject, nonDTS: bool = False, urlRewritePluginClass: str | None = None) → tuple[arelle.ModelObject.ModelObject, arelle.ModelDocument.ModelDocument | None, str | None] | None

instanceDiscover(xbrlElement: arelle.ModelObject.ModelObject) → None

instanceContentsDiscover(xbrlElement: arelle.ModelObject.ModelObject) → None

contextDiscover(modelContext: arelle.ModelInstanceObject.ModelContext, setTargetModelXbrl: bool = False) → None

unitDiscover(unitElement: arelle.ModelInstanceObject.ModelUnit, setTargetModelXbrl: bool = False) → None

inlineXbrlDiscover(htmlElement: arelle.ModelObject.ModelObject) → None

factDiscover(modelFact: arelle.ModelInstanceObject.ModelFact, parentModelFacts: list[arelle.ModelInstanceObject.ModelFact] | None = None, parentElement: arelle.ModelObject.ModelObject | None = None) → None

testcasesIndexDiscover(rootNode: lxml.etree._ElementTree, validateTestcaseSchema: bool) → None

testcaseDiscover(testcaseElement: arelle.ModelObject.ModelObject, validateTestcaseSchema: bool) → None

registryDiscover(rootNode: arelle.ModelObject.ModelObject) → None

xPathTestSuiteDiscover(rootNode: arelle.ModelObject.ModelObject) → None

addDocumentReference(doc: arelle.ModelDocument.ModelDocument, referenceType: str, referringModelObject: arelle.ModelObject.ModelObject | None = None) → None