arelle-release 2.37.46__py3-none-any.whl → 2.38.0__py3-none-any.whl

arelle/plugin/validate/EDINET/{InstanceType.py → ReportFolderType.py}

@@ -7,17 +7,20 @@ from enum import Enum
 from functools import cached_property, lru_cache
 from pathlib import Path
 
+from regex import Pattern
 
-class InstanceType(Enum):
+from . import Constants
+
+
+class ReportFolderType(Enum):
     ATTACH_DOC = "AttachDoc"
     AUDIT_DOC = "AuditDoc"
-    ENGLISH_DOC = "EnglishDoc"
     PRIVATE_ATTACH = "PrivateAttach"
     PRIVATE_DOC = "PrivateDoc"
     PUBLIC_DOC = "PublicDoc"
 
     @classmethod
-    def parse(cls, value: str) -> InstanceType | None:
+    def parse(cls, value: str) -> ReportFolderType | None:
         try:
             return cls(value)
         except ValueError:
@@ -27,6 +30,14 @@ class InstanceType(Enum):
     def extensionCategory(self) -> ExtensionCategory | None:
         return FORM_TYPE_EXTENSION_CATEGORIES.get(self, None)
 
+    @cached_property
+    def isAttachment(self) -> bool:
+        return "Attach" in self.value
+
+    @cached_property
+    def ixbrlFilenamePatterns(self) -> list[Pattern[str]]:
+        return IXBRL_FILENAME_PATTERNS.get(self, [])
+
     @cached_property
     def manifestName(self) -> str:
         return f'manifest_{self.value}.xml'
@@ -35,10 +46,22 @@ class InstanceType(Enum):
     def manifestPath(self) -> Path:
         return self.xbrlDirectory / self.manifestName
 
+    @cached_property
+    def namespaceUriPatterns(self) -> list[Pattern[str]]:
+        return NAMESPACE_URI_PATTERNS.get(self, [])
+
+    @cached_property
+    def prefixPatterns(self) -> list[Pattern[str]]:
+        return PREFIX_PATTERNS.get(self, [])
+
     @cached_property
     def xbrlDirectory(self) -> Path:
         return Path('XBRL') / str(self.value)
 
+    @cached_property
+    def xbrlFilenamePatterns(self) -> list[Pattern[str]]:
+        return XBRL_FILENAME_PATTERNS.get(self, [])
+
     @lru_cache(1)
     def getValidExtensions(self, isAmendment: bool, isSubdirectory: bool) -> frozenset[str] | None:
         if self.extensionCategory is None:
@@ -49,7 +72,6 @@ class InstanceType(Enum):
 class ExtensionCategory(Enum):
     ATTACH = 'ATTACH'
     DOC = 'DOC'
-    ENGLISH_DOC = 'ENGLISH_DOC'
 
     def getValidExtensions(self, isAmendment: bool, isSubdirectory: bool) -> frozenset[str] | None:
         amendmentMap = VALID_EXTENSIONS[isAmendment]
@@ -60,12 +82,11 @@ class ExtensionCategory(Enum):
 
 
 FORM_TYPE_EXTENSION_CATEGORIES = {
-    InstanceType.ATTACH_DOC: ExtensionCategory.ATTACH,
-    InstanceType.AUDIT_DOC: ExtensionCategory.DOC,
-    InstanceType.ENGLISH_DOC: ExtensionCategory.ENGLISH_DOC,
-    InstanceType.PRIVATE_ATTACH: ExtensionCategory.ATTACH,
-    InstanceType.PRIVATE_DOC: ExtensionCategory.DOC,
-    InstanceType.PUBLIC_DOC: ExtensionCategory.DOC,
+    ReportFolderType.ATTACH_DOC: ExtensionCategory.ATTACH,
+    ReportFolderType.AUDIT_DOC: ExtensionCategory.DOC,
+    ReportFolderType.PRIVATE_ATTACH: ExtensionCategory.ATTACH,
+    ReportFolderType.PRIVATE_DOC: ExtensionCategory.DOC,
+    ReportFolderType.PUBLIC_DOC: ExtensionCategory.DOC,
 }
 
 
@@ -74,7 +95,6 @@ IMAGE_EXTENSIONS = frozenset({'.jpeg', '.jpg', '.gif', '.png'})
 ASSET_EXTENSIONS = frozenset(HTML_EXTENSIONS | IMAGE_EXTENSIONS)
 XBRL_EXTENSIONS = frozenset(HTML_EXTENSIONS | {'.xml', '.xsd'})
 ATTACH_EXTENSIONS = frozenset(HTML_EXTENSIONS | {'.pdf', })
-ENGLISH_DOC_EXTENSIONS = frozenset(ASSET_EXTENSIONS | frozenset({'.pdf', '.xml', '.txt'}))
 
 # Is Amendment -> Category -> Is Subdirectory
 VALID_EXTENSIONS = {
@@ -97,9 +117,46 @@ VALID_EXTENSIONS = {
             False: HTML_EXTENSIONS,
             True: ASSET_EXTENSIONS,
         },
-        ExtensionCategory.ENGLISH_DOC: {
-            False: ENGLISH_DOC_EXTENSIONS,
-            True: ENGLISH_DOC_EXTENSIONS,
-        },
     },
 }
+
+IXBRL_FILENAME_PATTERNS = {
+    ReportFolderType.AUDIT_DOC: [
+        Constants.AUDIT_IXBRL_FILENAME_PATTERN,
+        Constants.AUDIT_LINKBASE_FILENAME_PATTERN,
+        Constants.AUDIT_SCHEMA_FILENAME_PATTERN,
+    ],
+    ReportFolderType.PUBLIC_DOC: [
+        Constants.REPORT_COVER_FILENAME_PATTERN,
+        Constants.REPORT_IXBRL_FILENAME_PATTERN,
+        Constants.REPORT_LINKBASE_FILENAME_PATTERN,
+        Constants.REPORT_SCHEMA_FILENAME_PATTERN,
+    ]
+}
+
+NAMESPACE_URI_PATTERNS = {
+    ReportFolderType.AUDIT_DOC: [
+        Constants.AUDIT_NAMESPACE_PATTERN,
+    ],
+    ReportFolderType.PUBLIC_DOC: [
+        Constants.REPORT_NAMESPACE_PATTERN,
+    ],
+}
+
+PREFIX_PATTERNS = {
+    ReportFolderType.AUDIT_DOC: [
+        Constants.AUDIT_PREFIX_PATTERN,
+    ],
+    ReportFolderType.PUBLIC_DOC: [
+        Constants.REPORT_PREFIX_PATTERN,
+    ],
+}
+
+XBRL_FILENAME_PATTERNS = {
+    ReportFolderType.AUDIT_DOC: [
+        Constants.AUDIT_XBRL_FILENAME_PATTERN,
+    ],
+    ReportFolderType.PUBLIC_DOC: [
+        Constants.REPORT_XBRL_FILENAME_PATTERN,
+    ],
+}

arelle/plugin/validate/EDINET/Statement.py

@@ -0,0 +1,139 @@
+from dataclasses import dataclass
+from decimal import Decimal
+from enum import Enum
+
+import regex
+
+from arelle.ModelInstanceObject import ModelFact
+
+CONSOLIDATED_ROLE_URI_PATTERN = regex.compile(r'.*rol_[\w]*Consolidated')
+
+STATEMENT_ROLE_URIS = frozenset([
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedQuarterPeriodConsolidatedStatementOfComprehensiveIncomeIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedQuarterPeriodConsolidatedStatementOfComprehensiveIncomeSingleStatementIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedQuarterPeriodConsolidatedStatementOfProfitOrLossIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedQuarterPeriodStatementOfComprehensiveIncomeIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedQuarterPeriodStatementOfComprehensiveIncomeSingleStatementIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedQuarterPeriodStatementOfProfitOrLossIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedQuarterlyConsolidatedStatementOfCashFlowsIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedQuarterlyConsolidatedStatementOfChangesInEquityIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedQuarterlyConsolidatedStatementOfComprehensiveIncomeIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedQuarterlyConsolidatedStatementOfComprehensiveIncomeSingleStatementIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedQuarterlyConsolidatedStatementOfFinancialPositionIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedQuarterlyConsolidatedStatementOfProfitOrLossIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedQuarterlyStatementOfCashFlowsIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedQuarterlyStatementOfChangesInEquityIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedQuarterlyStatementOfComprehensiveIncomeIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedQuarterlyStatementOfComprehensiveIncomeSingleStatementIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedQuarterlyStatementOfFinancialPositionIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedQuarterlyStatementOfProfitOrLossIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedSemiAnnualConsolidatedStatementOfCashFlowsIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedSemiAnnualConsolidatedStatementOfChangesInEquityIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedSemiAnnualConsolidatedStatementOfComprehensiveIncomeIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedSemiAnnualConsolidatedStatementOfComprehensiveIncomeSingleStatementIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedSemiAnnualConsolidatedStatementOfFinancialPositionIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedSemiAnnualConsolidatedStatementOfProfitOrLossIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedSemiAnnualStatementOfCashFlowsIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedSemiAnnualStatementOfChangesInEquityIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedSemiAnnualStatementOfComprehensiveIncomeIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedSemiAnnualStatementOfComprehensiveIncomeSingleStatementIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedSemiAnnualStatementOfFinancialPositionIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedSemiAnnualStatementOfProfitOrLossIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedYearToQuarterEndConsolidatedStatementOfComprehensiveIncomeIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedYearToQuarterEndConsolidatedStatementOfComprehensiveIncomeSingleStatementIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedYearToQuarterEndConsolidatedStatementOfProfitOrLossIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedYearToQuarterEndStatementOfComprehensiveIncomeIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedYearToQuarterEndStatementOfComprehensiveIncomeSingleStatementIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_CondensedYearToQuarterEndStatementOfProfitOrLossIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_ConsolidatedStatementOfCashFlowsIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_ConsolidatedStatementOfChangesInEquityIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_ConsolidatedStatementOfComprehensiveIncomeIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_ConsolidatedStatementOfComprehensiveIncomeSingleStatementIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_ConsolidatedStatementOfFinancialPositionIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_ConsolidatedStatementOfProfitOrLossIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_StatementOfCashFlowsIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_StatementOfChangesInEquityIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_StatementOfComprehensiveIncomeIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_StatementOfComprehensiveIncomeSingleStatementIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_StatementOfFinancialPositionIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_StatementOfProfitOrLossIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_std_ConsolidatedStatementOfCashFlowsIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_std_ConsolidatedStatementOfChangesInEquityIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_std_ConsolidatedStatementOfComprehensiveIncomeIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_std_ConsolidatedStatementOfFinancialPositionIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jpigp/rol_std_ConsolidatedStatementOfProfitOrLossIFRS',
+    'http://disclosure.edinet-fsa.go.jp/role/jppfs/rol_BalanceSheet',
+    'http://disclosure.edinet-fsa.go.jp/role/jppfs/rol_ConsolidatedBalanceSheet',
+    'http://disclosure.edinet-fsa.go.jp/role/jppfs/rol_QuarterlyBalanceSheet',
+    'http://disclosure.edinet-fsa.go.jp/role/jppfs/rol_QuarterlyConsolidatedBalanceSheet',
+    'http://disclosure.edinet-fsa.go.jp/role/jppfs/rol_SemiAnnualBalanceSheet',
+    'http://disclosure.edinet-fsa.go.jp/role/jppfs/rol_SemiAnnualConsolidatedBalanceSheet',
+    'http://disclosure.edinet-fsa.go.jp/role/jppfs/rol_Type1SemiAnnualBalanceSheet',
+    'http://disclosure.edinet-fsa.go.jp/role/jppfs/rol_Type1SemiAnnualConsolidatedBalanceSheet',
+    'http://disclosure.edinet-fsa.go.jp/role/jppfs/rol_std_BalanceSheet',
+    'http://disclosure.edinet-fsa.go.jp/role/jppfs/rol_std_ConsolidatedBalanceSheet',
+    'http://disclosure.edinet-fsa.go.jp/role/jppfs/rol_std_QuarterlyBalanceSheet',
+    'http://disclosure.edinet-fsa.go.jp/role/jppfs/rol_std_QuarterlyConsolidatedBalanceSheet',
+    'http://disclosure.edinet-fsa.go.jp/role/jppfs/rol_std_SemiAnnualBalanceSheet',
+    'http://disclosure.edinet-fsa.go.jp/role/jppfs/rol_std_SemiAnnualConsolidatedBalanceSheet',
+    'http://disclosure.edinet-fsa.go.jp/role/jppfs/rol_std_Type1SemiAnnualBalanceSheet',
+    'http://disclosure.edinet-fsa.go.jp/role/jppfs/rol_std_Type1SemiAnnualConsolidatedBalanceSheet',
+])
+
+
+class StatementType(Enum):
+    BALANCE_SHEET = 'BalanceSheet'
+    CONSOLIDATED_BALANCE_SHEET = 'ConsolidatedBalanceSheetIFRS'
+    STATEMENT_OF_CASH_FLOWS = 'StatementOfCashFlowsIFRS'
+    STATEMENT_OF_CHANGES_IN_EQUITY = 'StatementOfChangesInEquityIFRS'
+    STATEMENT_OF_COMPREHENSIVE_INCOME = 'StatementOfComprehensiveIncomeIFRS'
+    STATEMENT_OF_COMPREHENSIVE_INCOME_SINGLE_STATEMENT = 'StatementOfComprehensiveIncomeSingleStatementIFRS'
+    STATEMENT_OF_FINANCIAL_POSITION = 'StatementOfFinancialPositionIFRS'
+    STATEMENT_OF_PROFIT_OR_LOSS = 'StatementOfProfitOrLossIFRS'
+
+
+@dataclass(frozen=True)
+class Statement:
+    isConsolidated: bool
+    roleUri: str
+    statementType: StatementType
+
+
+@dataclass(frozen=True)
+class BalanceSheet:
+    creditSum: Decimal
+    contextId: str
+    facts: list[ModelFact]
+    debitSum: Decimal
+    unitId: str
+
+
+@dataclass(frozen=True)
+class StatementInstance:
+    balanceSheets: list[BalanceSheet]
+    statement: Statement
+
+def _buildStatements() -> frozenset[Statement]:
+    """
+    Build a frozenset of Statement objects from the STATEMENT_ROLE_URIS.
+    This is done to avoid re-evaluating the set comprehension multiple times.
+    """
+    statements = []
+    for roleUri in STATEMENT_ROLE_URIS:
+        isConsolidated = bool(CONSOLIDATED_ROLE_URI_PATTERN.match(roleUri))
+        statementType=next(
+            statementType
+            for statementType in StatementType
+            if roleUri.endswith(statementType.value)
+        )
+        statements.append(
+            Statement(
+                isConsolidated=isConsolidated,
+                roleUri=roleUri,
+                statementType=statementType
+            )
+        )
+    return frozenset(statements)
+
+
+STATEMENTS = _buildStatements()