# {py:mod}`arelle.Validate` ```{py:module} arelle.Validate ``` ```{autodoc2-docstring} arelle.Validate :allowtitles: ``` ## Module Contents ### Classes ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`Validate ` - ```{autodoc2-docstring} arelle.Validate.Validate :summary: ``` * - {py:obj}`ValidationLogListener ` - ```` ### Functions ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`validate ` - ```{autodoc2-docstring} arelle.Validate.validate :summary: ``` ```` ### Data ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`_ ` - ```{autodoc2-docstring} arelle.Validate._ :summary: ``` * - {py:obj}`commaSpaceSplitPattern ` - ```{autodoc2-docstring} arelle.Validate.commaSpaceSplitPattern :summary: ``` ```` ### API ````{py:data} _ :canonical: arelle.Validate._ :type: arelle.typing.TypeGetText :value: > None ```{autodoc2-docstring} arelle.Validate._ ``` ```` ````{py:function} validate(modelXbrl: arelle.ModelXbrl.ModelXbrl) -> None :canonical: arelle.Validate.validate ```{autodoc2-docstring} arelle.Validate.validate ``` ```` `````{py:exception} ValidationException(message: str, severity: str, code: str) :canonical: arelle.Validate.ValidationException Bases: {py:obj}`Exception` ````{py:method} __repr__() -> str :canonical: arelle.Validate.ValidationException.__repr__ ```` ````` ````{py:data} commaSpaceSplitPattern :canonical: arelle.Validate.commaSpaceSplitPattern :value: > 'compile(...)' ```{autodoc2-docstring} arelle.Validate.commaSpaceSplitPattern ``` ```` `````{py:class} Validate(modelXbrl: arelle.ModelXbrl.ModelXbrl) :canonical: arelle.Validate.Validate ```{autodoc2-docstring} arelle.Validate.Validate ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} arelle.Validate.Validate.__init__ ``` ````{py:attribute} useFileSource :canonical: arelle.Validate.Validate.useFileSource :type: arelle.FileSource.FileSource | None :value: > None ```{autodoc2-docstring} arelle.Validate.Validate.useFileSource ``` ```` ````{py:method} filterTestcaseVariation(modelTestcaseVariation: arelle.ModelTestcaseObject.ModelTestcaseVariation) -> bool :canonical: arelle.Validate.Validate.filterTestcaseVariation ```{autodoc2-docstring} arelle.Validate.Validate.filterTestcaseVariation ``` ```` ````{py:method} close() -> None :canonical: arelle.Validate.Validate.close ```{autodoc2-docstring} arelle.Validate.Validate.close ``` ```` ````{py:method} validate() -> None :canonical: arelle.Validate.Validate.validate ```{autodoc2-docstring} arelle.Validate.Validate.validate ``` ```` ````{py:method} validateRssFeed() -> None :canonical: arelle.Validate.Validate.validateRssFeed ```{autodoc2-docstring} arelle.Validate.Validate.validateRssFeed ``` ```` ````{py:method} validateTestcase(testcase: arelle.ModelDocument.ModelDocument) -> None :canonical: arelle.Validate.Validate.validateTestcase ```{autodoc2-docstring} arelle.Validate.Validate.validateTestcase ``` ```` ````{py:method} _validateTestcaseVariation(testcase: arelle.ModelDocument.ModelDocument, modelTestcaseVariation: arelle.ModelTestcaseObject.ModelTestcaseVariation) -> None :canonical: arelle.Validate.Validate._validateTestcaseVariation ```{autodoc2-docstring} arelle.Validate.Validate._validateTestcaseVariation ``` ```` ````{py:method} _testcaseLoadReadMeFirstUri(testcase: arelle.ModelDocument.ModelDocument, modelTestcaseVariation: arelle.ModelTestcaseObject.ModelTestcaseVariation, index: int, readMeFirstUri: str | tuple[str, str], resultIsVersioningReport: bool, resultIsTaxonomyPackage: bool, inputDTSes: dict[str | None, list[arelle.ModelXbrl.ModelXbrl]], errorCaptureLevel: int, baseForElement: str, parameters: dict[str | arelle.ModelValue.QName, tuple[arelle.ModelValue.QName | None, typing.Any]]) -> list[arelle.ModelXbrl.ModelXbrl] :canonical: arelle.Validate.Validate._testcaseLoadReadMeFirstUri ```{autodoc2-docstring} arelle.Validate.Validate._testcaseLoadReadMeFirstUri ``` ```` ````{py:method} _testcaseValidateInputDTS(testcase: arelle.ModelDocument.ModelDocument, modelTestcaseVariation: arelle.ModelTestcaseObject.ModelTestcaseVariation, errorCaptureLevel: int, parameters: dict[str | arelle.ModelValue.QName, tuple[None, list[arelle.ModelXbrl.ModelXbrl]]], inputDTSes: dict[str | None, list[arelle.ModelXbrl.ModelXbrl]], baseForElement: str, resultIsXbrlInstance: bool) -> None :canonical: arelle.Validate.Validate._testcaseValidateInputDTS ```{autodoc2-docstring} arelle.Validate.Validate._testcaseValidateInputDTS ``` ```` ````{py:method} noErrorCodes(modelTestcaseVariationActual: typing.Iterable[typing.Any]) -> bool :canonical: arelle.Validate.Validate.noErrorCodes ```{autodoc2-docstring} arelle.Validate.Validate.noErrorCodes ``` ```` ````{py:method} determineTestStatus(modelTestcaseVariation: arelle.ModelTestcaseObject.ModelTestcaseVariation, errors: arelle.ErrorManager.ErrorsType, validateModelCount: int | None = None) -> None :canonical: arelle.Validate.Validate.determineTestStatus ```{autodoc2-docstring} arelle.Validate.Validate.determineTestStatus ``` ```` ````` `````{py:class} ValidationLogListener(logView: typing.Any) :canonical: arelle.Validate.ValidationLogListener Bases: {py:obj}`logging.Handler` ````{py:method} flush() -> None :canonical: arelle.Validate.ValidationLogListener.flush ```{autodoc2-docstring} arelle.Validate.ValidationLogListener.flush ``` ```` ````{py:method} emit(logRecord: logging.LogRecord) -> None :canonical: arelle.Validate.ValidationLogListener.emit ```` `````