Module secfsdstools.f_standardize.is_standardize
Contains the definitions to standardize incaome statements.
Expand source code
# pylint: disable=C0302
"""Contains the definitions to standardize incaome statements."""
from typing import List, Set, Optional
import pandas as pd
import pandera as pa
from secfsdstools.f_standardize.base_prepivot_rules import (PrePivotDeduplicate,
PrePivotCorrectSign, PrePivotMaxQtrs)
from secfsdstools.f_standardize.base_rule_framework import RuleGroup, Rule
from secfsdstools.f_standardize.base_rules import (CopyTagRule, SumUpRule, SubtractFromRule,
missingsumparts_rules_creator,
MissingSummandRule, PostSetToZero, PostFixSign)
from secfsdstools.f_standardize.base_validation_rules import ValidationRule, SumValidationRule, \
ProductValidationRule
from secfsdstools.f_standardize.standardizing import Standardizer
# All tags that are used for costs of goods and services
# pylint: disable=C0301
cost_of_GaS_tags = ['CostOfGoodsSold',
'CostOfServices',
'CostOfGoodsAndServicesSold',
'CostOfRevenue',
'CostOfGoodsSoldExcludingDepreciationDepletionAndAmortization',
'CostOfGoodsSoldDepreciationDepletionAndAmortization',
'CostOfGoodsSoldDepletion',
'CostOfGoodsSoldDepreciation',
'CostOfGoodsSoldAmortization',
'CostOfGoodsSoldDepreciationAndAmortization',
'CostOfGoodsSoldDirectFinancingLease',
'CostOfGoodsSoldElectric',
'CostOfGoodsSoldDirectMaterials',
'CostOfGoodsSoldDirectLabor',
'CostOfGoodsSoldOverhead',
'CostOfGoodsSoldOilAndGas',
'CostOfGoodsSoldSubscription',
'CostOfGoodsSoldDirectTaxesAndLicensesCosts',
'CostOfGoodsSoldMaintenanceCosts',
'CostOfGoodsSoldSalesTypeLease',
'CostOfServicesExcludingDepreciationDepletionAndAmortization',
'CostOfServicesDepreciation',
'CostOfServicesDepreciationAndAmortization',
'CostOfServicesCatering',
'CostOfServicesAmortization',
'CostOfServicesOilAndGas',
'CostOfServicesDirectTaxesAndLicensesCosts',
'CostOfServicesMaintenanceCosts',
'CostOfServicesLicensesAndServices',
'CostOfServicesDirectLabor',
'CostOfServicesLicensesAndMaintenanceAgreements',
'CostOfServicesEnergyServices',
'CostOfServicesDirectMaterials',
'CostOfServicesEnvironmentalRemediation',
'CostOfServicesOverhead',
'CostOfGoodsAndServicesSoldDepreciationAndAmortization',
'CostOfGoodsAndServicesSoldAmortization',
'CostOfGoodsAndServicesSoldOverhead',
'CostOfGoodsAndServicesSoldDepreciation',
'CostOfGoodsAndServicesEnergyCommoditiesAndServices',
'CostOfGoodsAndServiceExcludingDepreciationDepletionAndAmortization'
]
# All tags containing detailled revenue values
# pylint: disable=C0301
detailled_revenue_tags = [
'RegulatedAndUnregulatedOperatingRevenue',
'HealthCareOrganizationPatientServiceRevenue',
'ContractsRevenue',
'RevenueOilAndGasServices',
'HealthCareOrganizationRevenue',
'RevenueMineralSales',
'SalesRevenueEnergyServices',
'RealEstateRevenueNet',
'OperatingLeasesIncomeStatementLeaseRevenue',
'LicensesRevenue', 'RevenueFromRelatedParties',
'BrokerageCommissionsRevenue', 'RoyaltyRevenue', 'OilAndGasSalesRevenue',
'OilAndGasRevenue', 'OtherRealEstateRevenue',
'TechnologyServicesRevenue', 'ManagementFeesRevenue',
'ReimbursementRevenue',
'OperatingLeasesIncomeStatementMinimumLeaseRevenue',
'FoodAndBeverageRevenue', 'MaintenanceRevenue',
'LicenseAndServicesRevenue', 'FranchiseRevenue', 'SubscriptionRevenue',
'FinancialServicesRevenue',
'RevenueFromGrants',
'GasGatheringTransportationMarketingAndProcessingRevenue',
'OccupancyRevenue', 'NaturalGasProductionRevenue',
'SalesRevenueServicesGross', 'InvestmentBankingRevenue',
'AdvertisingRevenue', 'RevenueOtherFinancialServices',
'OilAndCondensateRevenue', 'RevenueFromLeasedAndOwnedHotels',
'RevenuesNetOfInterestExpense', 'RegulatedAndUnregulatedOperatingRevenue',
'UnregulatedOperatingRevenue', 'ElectricUtilityRevenue',
'CargoAndFreightRevenue', 'OtherHotelOperatingRevenue',
'CasinoRevenue', 'RefiningAndMarketingRevenue',
'PrincipalTransactionsRevenue', 'InterestRevenueExpenseNet',
'HomeBuildingRevenue', 'OtherRevenueExpenseFromRealEstateOperations',
'GasDomesticRegulatedRevenue', 'LicenseAndMaintenanceRevenue',
'RegulatedOperatingRevenue', 'AdmissionsRevenue', 'PassengerRevenue'
]
# The 100 most common tags which appear between GrossProfit and OperatingIncomeLoss
# pylint: disable=C0301
top_100_operating_costs_tags = [
'SellingGeneralAndAdministrativeExpense',
'GeneralAndAdministrativeExpense',
'ResearchAndDevelopmentExpense',
'SellingAndMarketingExpense',
'AmortizationOfIntangibleAssets',
'DepreciationAndAmortization',
'RestructuringCharges',
'ProfessionalFees',
'SellingExpense',
'AssetImpairmentCharges',
'OtherOperatingIncomeExpenseNet',
'DepreciationDepletionAndAmortization',
'LaborAndRelatedExpense',
'BusinessCombinationAcquisitionRelatedCosts',
'GoodwillImpairmentLoss',
'Depreciation',
'OtherCostAndExpenseOperating',
'MarketingAndAdvertisingExpense',
'RestructuringSettlementAndImpairmentProvisions',
'SalariesAndWages',
'ShareBasedCompensation',
'ProvisionForDoubtfulAccounts',
'GainLossOnDispositionOfAssets',
'CostsAndExpenses',
'OperatingCostsAndExpenses',
'OtherGeneralAndAdministrativeExpense',
'ResearchAndDevelopmentExpenseExcludingAcquiredInProcessCost',
'GainLossOnSaleOfPropertyPlantEquipment',
'GoodwillAndIntangibleAssetImpairment',
'MarketingExpense',
'GainLossOnDispositionOfAssets1',
'AdvertisingExpense',
'BusinessCombinationContingentConsiderationArrangementsChangeInAmountOfContingentConsiderationLiability1',
'LeaseAndRentalExpense',
'LegalFees',
'OtherSellingGeneralAndAdministrativeExpense',
'GainLossRelatedToLitigationSettlement',
'IncomeLossFromEquityMethodInvestments',
'DepreciationNonproduction',
'AllocatedShareBasedCompensationExpense',
'SalariesWagesAndOfficersCompensation',
'TravelAndEntertainmentExpense',
'ImpairmentOfLongLivedAssetsHeldForUse',
'ResearchAndDevelopmentExpenseSoftwareExcludingAcquiredInProcessCost',
'OfficersCompensation',
'OtherGeneralExpense',
'ImpairmentOfIntangibleAssetsExcludingGoodwill',
'OtherOperatingIncome',
'ProfessionalAndContractServicesExpense',
'LitigationSettlementExpense',
'GainLossOnSaleOfBusiness',
'ImpairmentOfIntangibleAssetsFinitelived',
'RestructuringCostsAndAssetImpairmentCharges',
'ForeignCurrencyTransactionGainLossBeforeTax',
'OtherDepreciationAndAmortization',
'OtherExpenses',
'RestructuringCosts',
'SalesCommissionsAndFees',
'BusinessCombinationIntegrationRelatedCosts',
'AdjustmentForAmortization',
'InterestExpense',
'ImpairmentOfIntangibleAssetsIndefinitelivedExcludingGoodwill',
'CommunicationsAndInformationTechnology',
'PreOpeningCosts',
'OtherNonrecurringIncomeExpense',
'GainLossOnSalesOfAssetsAndAssetImpairmentCharges',
'OtherAssetImpairmentCharges',
'ImpairmentOfLongLivedAssetsToBeDisposedOf',
'DisposalGroupNotDiscontinuedOperationGainLossOnDisposal',
'GainLossOnSaleOfOtherAssets',
'ShippingHandlingAndTransportationCosts',
'RoyaltyExpense',
'GeneralInsuranceExpense',
'ManagementFeeExpense',
'GainsLossesOnSalesOfAssets',
'OccupancyNet',
'TaxesExcludingIncomeAndExciseTaxes',
'TechnologyServicesCosts',
'OtherIncome',
'RestructuringAndRelatedCostIncurredCost',
'OtherLaborRelatedExpenses',
'SeveranceCosts1',
'UtilitiesOperatingExpenseMaintenanceAndOperations',
'EmployeeBenefitsAndShareBasedCompensation',
'BusinessDevelopment',
'CostsAndExpensesRelatedParty',
'ExplorationExpenseMining',
'DepreciationAmortizationAndAccretionNet',
'GainLossOnDispositionOfProperty',
'InventoryWriteDown',
'AssetRetirementObligationAccretionExpense',
'InsuranceRecoveries',
'AmortizationOfAcquiredIntangibleAssets',
'GainsLossesOnExtinguishmentOfDebt',
'AmortizationOfAcquisitionCosts',
'TangibleAssetImpairmentCharges',
'ResearchAndDevelopmentInProcess',
'OperatingLeasesRentExpenseNet',
'OperatingLeaseExpense',
]
class PostFixIncomeLossFromContinuingOperationsAndSignOfIncomeTaxExpenseBenefit(Rule):
"""
Usually, when TaxExpenseBenefit is a positive number, meaning that this amount
of taxes were paid by the company. Therefore, the equation
IncomeLossBeforeTaxes - TaxExpenseBenefit = NetIncomeLoss
However, there is a quite significant number of reports, which us a negative
number to display paid Taxes and therefore, the following equations would be
used:
IncomeLossBeforeTaxes + TaxExpenseBenefit = NetIncomeLoss
This rule select these entries and tries to fix that, whenever possible.
Since the rules calculate IncomeLossFromContinuingOperations as follows
IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit
- IncomeTaxExpenseBenefit
= IncomeLossFromContinuingOperations
We might end up having a wrong value for IncomeLossFromContinuingOperation.
Therefore, we mask the entries, where
abs(NetIncomeLoss - IncomeLossFromContinuingOperations) = 2*abs(IncomeTaxExpenseBenefit)
if IncomeTaxExpenseBenefit > 0
in order to fix the sign for IncomeTaxExpenseBenefit and to correct
IncomeLossFromContinuingOperations
The rule also uses some threshold.
Of course, this is not perfect and does not consider the cases with DiscontinuedOperations,
However, it is able to fix a significant number of cases.
For the masked entries, it changes the sign of TaxExpenseBenefit
and recalculates IncomeLossFromContinuingOperations
"""
def get_target_tags(self) -> List[str]:
"""
returns a list of tags that could be affected/changed by this rule
Returns:
List[str]: list with affected tags/columns
"""
return ['IncomeLossFromContinuingOperations', 'AllIncomeTaxExpenseBenefit']
def get_input_tags(self) -> Set[str]:
"""
return all tags that the rules within this group need.
Returns:
Set[str]: set of all input tags that are used by rules in this group
"""
return {'IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit',
'AllIncomeTaxExpenseBenefit', 'IncomeLossFromContinuingOperations', 'ProfitLoss'}
def mask(self, data_df: pd.DataFrame) -> pa.typing.Series[bool]:
"""
returns a Series[bool] which defines the rows to which this rule has to be applied.
Args:
data_df dataframe on which the rules should be applied
Returns:
pa.typing.Series[bool]: a boolean Series that marks which rows have to be calculated
"""
return (data_df.AllIncomeTaxExpenseBenefit != 0) & \
((data_df.ProfitLoss - data_df.IncomeLossFromContinuingOperations).abs() >=
1.8 * data_df.AllIncomeTaxExpenseBenefit.abs())
def apply(self, data_df: pd.DataFrame, mask: pa.typing.Series[bool]) -> pd.DataFrame:
"""
apply the rule on the provided dataframe. the rows, on which the rule has to be applied
is defined by the provide mask Series.
Important, the rules have to be applied "in-place", so no new dataframe is produced.
Args:
data_df: dataframe on which the rule has to be applied
mask: a Series marking the rows in the dataframe on which the rule has to be applied
Returns:
pd.DataFrame: make the process chainable
"""
data_df.loc[mask, 'AllIncomeTaxExpenseBenefit'] = -data_df.AllIncomeTaxExpenseBenefit
# recalculate IncomeLossFromContinuingOperations
data_df.loc[mask, 'IncomeLossFromContinuingOperations'] = \
data_df['IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit']
subtract_mask = mask & ~data_df.AllIncomeTaxExpenseBenefit.isna()
data_df.loc[subtract_mask, 'IncomeLossFromContinuingOperations'] = (
data_df['IncomeLossFromContinuingOperations'] -
data_df.AllIncomeTaxExpenseBenefit)
return data_df
def get_description(self) -> str:
return "Corrects the sign of 'IncomeTaxExpenseBenefits' if it seems to be wrong. Checks" \
"if the difference between 'NetIncomeLoss' and " \
"'IncomeLossFromContinuingOperations'" \
"is about 2. Which is a clear indication, that the sign was wrong."
# pylint: disable=C0301
class IncomeStatementStandardizer(Standardizer):
"""
The goal of this Standardizer is to create IncomeStatements that are comparable,
meaning that they have the same tags.
At the end, the standardized IS contains the following columns
<pre>
Revenues
- CostOfRevenue
---------------
= GrossProfit
- OperatingExpenses
-------------------
= OperatingIncomeLoss
IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit
- AllIncomeTaxExpenseBenefit
----------------------------
= IncomeLossFromContinuingOperations
+ IncomeLossFromDiscontinuedOperationsNetOfTax
-----------------------------------------------
= ProfitLoss
- NetIncomeLossAttributableToNoncontrollingInterest
---------------------------------------------------
= NetIncomeLoss
</pre>
Detailled View:
<pre>
Main Rules
Revenues:
Pre
+ SalesRevenueGoodsNet <- SalesRevenueGoodsGross
+ SalesRevenueServicesNet <- SalesRevenueServicesGross
+ OtherSalesRevenueNet
--------------
= SalesRevenueNet
RevenueFromContractWithCustomerIncludingAssessedTax
- ExciseAndSalesTaxes
---------------------
= RevenueFromContractWithCustomerExcludingAssessedTax
+ RegulatedAndUnregulatedOperatingRevenue
+ HealthCareOrganizationPatientServiceRevenue
+ ContractsRevenue
+ RevenueOilAndGasServices
...
------------------
= RevenuesSum
Set
1. Prio: Revenues
2. Prio: SalesRevenueNet
3. Prio: RevenueFromContractWithCustomerExcludingAssessedTax
4. Prio: RevenueFromContractWithCustomerIncludingAssessedTax
5. Prio: RevenuesExcludingInterestAndDividends
6. Prio: RevenuesSum
7. Prio: InvestmentIncomeInterest
8. Prio: CostOfRevenue + GrossProfit
CostOfRevenue
Pre
+ CostOfGoodsSoldExcludingDepreciationDepletionAndAmortization
+ CostOfGoodsSoldDepreciationDepletionAndAmortization
+ CostOfGoodsSoldDepletion
+ CostOfGoodsSoldDepreciation
+ ...
------------
= CostOfGoodsSold (if not set)
+ CostOfServicesExcludingDepreciationDepletionAndAmortization
+ CostOfServicesDepreciation
+ CostOfServicesDepreciationAndAmortization
+ CostOfServicesCatering
+ ...
------------
= CostOfServices (if not set)
+ CostOfGoodsAndServicesSoldDepreciationAndAmortization
+ CostOfGoodsAndServicesSoldAmortization
+ CostOfGoodsAndServicesSoldOverhead
+ CostOfGoodsAndServicesSoldDepreciation
+ CostOfGoodsAndServicesEnergyCommoditiesAndServices
+ CostOfGoodsAndServiceExcludingDepreciationDepletionAndAmortizatio
------------
= CostOfGoodsAndServicesSold (if not set)
CostOfGoodsSold
+ CostOfServices
---------------
= CostOfGoodsAndServicesSold (if not set)
Set
1. Prio CostOfRevenue
2. Prio CostOfGoodsAndServicesSold
3. Prio Revenues - GrossProfit
GrossProfit
1. Prio GrossProfit
2. Prio Revenues - CostOfRevenue
3. Prio GrossInvestmentIncomeOperating
4. Prio InterestAndDividendIncomeOperating
OperatingExpenses
Pre
+ SellingGeneralAndAdministrativeExpense
+ GeneralAndAdministrativeExpense
+ ResearchAndDevelopmentExpense
+ SellingAndMarketingExpense
+ ... (96 most expense tags)
----------------------------
= OperatingExpensesSum
Set
1. Prio OperatingExpenses
2. Prio GrossProfit - OperatingIncomeLoss
3. Prio OperatingExpensesSum
OperatingIncomeLoss
Set
1. Prio OperatingIncomeLoss
2. Prio GrossProfit - OperatingExpenses
IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit
Pre
+ IncomeLossFromContinuingOperationsBeforeIncomeTaxesMinorityInterestAndIncomeLossFromEquityMethodInvestments
+ (Optional) IncomeLossFromEquityMethodInvestments
--------------------------------------------------
= IncomeLossFromContinuingOperationsFromEquityMethodInvestements
Set
1. Prio IncomeLossFromContinuingOperationsBeforeIncomeTaxesExtraordinaryItemsNoncontrollingInterest rename
2. Prio IncomeLossFromContinuingOperationsFromEquityMethodInvestements
3. Prio IncomeLossFromContinuingOperations + AllIncomeTaxExpenseBenefit
NetIncome
Pre
+ IncomeTaxExpenseBenefit
+ DeferredIncomeTaxExpenseBenefit
+ (optional) IncomeLossFromEquityMethodInvestments
---------------------------------
= AllIncomeTaxExpenseBenefit
IncomeLossFromContinuingOperations <- (rename) IncomeLossFromContinuingOperationsIncludingPortionAttributableToNoncontrollingInterest
IncomeLossFromDiscontinuedOperationsNetOfTax <- (rename) IncomeLossFromDiscontinuedOperationsNetOfTaxAttributableToReportingEntity
+ IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit
- AllIncomeTaxExpenseBenefit
---------------------------------
= IncomeLossFromContinuingOperations
+ IncomeLossFromContinuingOperations
+ IncomeLossFromDiscontinuedOperationsNetOfTax
-------------------------
= ProfitLossParts
SetProfitLoss
1. Prio ProfitLoss
2. Prio ProfitLossParts
3. Prio NetIncomeLoss
SetIncomeLossContinuingOperations
3. Prio ProfitLoss
SetNetIncomeLoss
1. Prio NetIncomeLoss
2. Prio NetIncomeLossAvailableToCommonStockholdersBasic
3. Prio NetIncomeLossAllocatedToLimitedPartners
3. Prio ProfitLoss
4. Prio ProfitLossIncludingRedeemableNonControllingInterest
5. Prio OtherComprehensiveIncomeLossNetOfTax
6. Prio ComprehensiveIncomeNetOfTax
7. Prio IncomeLossAttributableToParent
8. Prio NetInvestmentIncome
OutstandingShares
1. Prio WeightedAverageNumberOfSharesOutstandingBasic
2. Prio WeightedAverageNumberOfDilutedSharesOutstanding
3. Prio WeightedAverageNumberOfShareOutstandingBasicAndDiluted
4. Prio WeightedAverageLimitedPartnershipUnitsOutstanding
5. Prio WeightedAverageLimitedPartnershipUnitsOutstandingDiluted
6. Prio WeightedAverageNumberOfLimitedPartnershipAndGeneralPartnershipUnitOutstandingBasicAndDiluted
7. Prio WeightedAverageGeneralPartnershipUnitsOutstanding
EarningsPerShare
1. Prio EarningsPerShareBasic
2. Prio EarningsPerShareDiluted
3. Prio EarningsPerShareBasicAndDiluted
4. Prio IncomeLossFromContinuingOperationsPerBasicShare
5. Prio IncomeLossFromContinuingOperationsPerDilutedShare
6. Prio IncomeLossFromContinuingOperationsPerBasicAndDilutedShare
7. Prio IncomeLossFromContinuingOperationsPerOutstandingLimitedPartnershipUnit
8. Prio IncomeLossFromContinuingOperationsPerOutstandingLimitedPartnershipUnitBasicNetOfTax
9. Prio IncomeLossFromContinuingOperationsPerOutstandingLimitedPartnershipAndGeneralPartnershipUnitBasicAndDiluted
Post Rule (Cleanup)
Fix Sign of AllIncomeTaxExpenseBenefit (should be positive if taxed were paid)
expected equation to be true:
IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit - AllIncomeTaxExpenseBenefit = ProfitLoss
invert sign of AllIncomeTaxExpenseBenefit if the following equation is true:
IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit + AllIncomeTaxExpenseBenefit = ProfitLoss
Fix sign of NetIncomeLossAttributableToNoncontrollingInterest
expected equation to be true:
ProfitLoss - NetIncomeLossAttributableToNoncontrollingInterest = NetIncomeLoss
invert sign of NetIncomeLossAttributableToNoncontrollingInterest if the following equation is true:
ProfitLoss + NetIncomeLossAttributableToNoncontrollingInterest = NetIncomeLoss
If Revenues was not set, but there is a GrossProfit, set it to GrossProfit,
since was no CostOfRevenue found
If GrossProfit couldn't be set, but there is Revenues, set it to Revenues
since was no CostOfRevenue found
if CostORevenues couldn't be set, but Revenues and GrossProfit are present, set it to Revenues - Grossprofit
if OperatingIncomeLoss is not set yet, and GrossProfit (available now) and OperatingExpenses are present,
set it to GrossProfit - OperatingExpenses
If there is no IncomeLossFromContinuingOperations, set it to ProfitLoss
if there is no IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit, set it to IncomeLossFromContinuingOperations
if there is no AllIncomeTaxExpenseBenefit, set it to IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit - AllIncomeTaxExpenseBenefit
set IncomeLossFromDiscontinuedOperationsNetOfTax to 0.0 if not present
If there is no IncomeLossFromContinuingOperations, set it to IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit
If there is no ProfitLoss, set it to IncomeLossFromContinuingOperations + IncomeLossFromDiscontinuedOperationsNetOfTax
If there is no NetIncomeLoss, set it to ProfitLoss
If there is no NetIncomeLossAttributableToNoncontrollingInterest, set it to ProfitLoss - NetIncomeLoss
</pre>
"""
prepivot_rule_tree = RuleGroup(
prefix="IS_PREPIV",
rules=[PrePivotDeduplicate(),
PrePivotMaxQtrs(max_qtrs=4),
PrePivotCorrectSign(
# all these tags are costOf and therefore should appear as a positive number
# since costs are subtracted from the Revenue to get the GrossProfit
tag_list=cost_of_GaS_tags,
is_positive=True
)]
)
is_revenue_rg = RuleGroup(
prefix="Rev",
rules=[
RuleGroup(prefix="Pre",
description="Preparation rules which might be usable to estimate the revenue",
rules=[
# normally, (Goods and Services) Gross and Net appear together, resp. Net has priority.
# so if net is not present, we copy the gross value in the net value
# and then sum the nets up to the SalesRevenue
CopyTagRule(
original='SalesRevenueGoodsGross',
target='SalesRevenueGoodsNet'),
CopyTagRule(
original='SalesRevenueServicesGross',
target='SalesRevenueServicesNet'),
SumUpRule(sum_tag='SalesRevenueNet',
potential_summands=[
'SalesRevenueGoodsNet',
'SalesRevenueServicesNet'],
optional_summands=[
'OtherSalesRevenueNet'
]),
# RevenueFromContractWithCustomer-tags are also often used to report the
# total Revenue. so the following rules take care of these cases.
# the order of the rules also defines the precedence.
# first: if RevenueFromContractWithCustomerExcludingAssessedTax is not set
# we calculate it from RevenueFromContractWithCustomerIncludingAssessedTax
# and ExciseAndSalesTaxes (if present)
SubtractFromRule(
subtract_from_tag='RevenueFromContractWithCustomerIncludingAssessedTax',
potential_subtract_tags=['ExciseAndSalesTaxes'],
target_tag='RevenueFromContractWithCustomerExcludingAssessedTax'),
# if we were not able to define the Revenue so far, there are
# a couple of other tags which define Revenue, so we count them together
# and set the total as Revenue
SumUpRule(sum_tag='RevenuesSum',
potential_summands=detailled_revenue_tags,
optional_summands=[
'OtherSalesRevenueNet'
]),
]),
RuleGroup(prefix="Set",
description="Rules that might set the Revenue tag."
"the order is the precedence.",
rules=[
# if Revenues is not set, we use the following precedence:
# - SalesRevenueNet
# - RevenueFromContractWithCustomerExcludingAssessedTax
# - RevenueFromContractWithCustomerIncludingAssessedTax
# - RevenuesExcludingInterestAndDividends
# - RevenuesSum
# - InvestmentIncomeInterest
CopyTagRule(original='SalesRevenueNet', target='Revenues'),
CopyTagRule(
original='RevenueFromContractWithCustomerExcludingAssessedTax',
target='Revenues'),
CopyTagRule(
original='RevenueFromContractWithCustomerIncludingAssessedTax',
target='Revenues'),
CopyTagRule(original='RevenuesExcludingInterestAndDividends',
target='Revenues'),
CopyTagRule(original='RevenuesSum', target='Revenues'),
CopyTagRule(original='InvestmentIncomeInterest', target='Revenues')])
]
)
is_costofrevenue_rg = RuleGroup(
prefix="CostOfRevenues",
rules=[
RuleGroup(prefix="Pre",
description="Preparation rules which might be usable to estimate "
"the cost of revenue",
rules=[
SumUpRule(sum_tag='CostOfGoodsSold',
potential_summands=[
'CostOfGoodsSoldExcludingDepreciationDepletionAndAmortization',
'CostOfGoodsSoldDepreciationDepletionAndAmortization',
'CostOfGoodsSoldDepletion',
'CostOfGoodsSoldDepreciation',
'CostOfGoodsSoldAmortization',
'CostOfGoodsSoldDepreciationAndAmortization',
'CostOfGoodsSoldDirectFinancingLease',
'CostOfGoodsSoldElectric',
'CostOfGoodsSoldDirectMaterials',
'CostOfGoodsSoldDirectLabor',
'CostOfGoodsSoldOverhead',
'CostOfGoodsSoldOilAndGas',
'CostOfGoodsSoldSubscription',
'CostOfGoodsSoldDirectTaxesAndLicensesCosts',
'CostOfGoodsSoldMaintenanceCosts',
'CostOfGoodsSoldSalesTypeLease']),
SumUpRule(sum_tag='CostOfServices',
potential_summands=[
'CostOfServicesExcludingDepreciationDepletionAndAmortization',
'CostOfServicesDepreciation',
'CostOfServicesDepreciationAndAmortization',
'CostOfServicesCatering',
'CostOfServicesAmortization',
'CostOfServicesOilAndGas',
'CostOfServicesDirectTaxesAndLicensesCosts',
'CostOfServicesMaintenanceCosts',
'CostOfServicesLicensesAndServices',
'CostOfServicesDirectLabor',
'CostOfServicesLicensesAndMaintenanceAgreements',
'CostOfServicesEnergyServices',
'CostOfServicesDirectMaterials',
'CostOfServicesEnvironmentalRemediation',
'CostOfServicesOverhead'
]),
SumUpRule(sum_tag='CostOfGoodsAndServicesSold',
potential_summands=[
'CostOfGoodsSold',
'CostOfServices']),
SumUpRule(sum_tag='CostOfGoodsAndServicesSold',
potential_summands=[
'CostOfGoodsAndServicesSoldDepreciationAndAmortization',
'CostOfGoodsAndServicesSoldAmortization',
'CostOfGoodsAndServicesSoldOverhead',
'CostOfGoodsAndServicesSoldDepreciation',
'CostOfGoodsAndServicesEnergyCommoditiesAndServices',
'CostOfGoodsAndServiceExcludingDepreciationDepletionAndAmortization']
)]),
RuleGroup(prefix="Set",
description="Rules that might set the CostOfRevenue tag."
"the order is the precedence.",
rules=[
CopyTagRule(original='CostOfGoodsAndServicesSold',
target='CostOfRevenue')])
]
)
is_missing_rev_cost_gross = RuleGroup(
prefix="RevCostGross_missing",
description="Calculates the third tag, if two of Revenues, CostOfRevenues, "
"and GrossProfit are present",
rules=missingsumparts_rules_creator(sum_tag='Revenues',
summand_tags=['CostOfRevenue', 'GrossProfit'])
)
is_grossprofit_rg = RuleGroup(
prefix='GrossProfit',
rules=[
RuleGroup(prefix="Set",
description="Rules that might set the GrossProfit tag."
"The order is the precedence.",
rules=[
# for investment companies
CopyTagRule(original='GrossInvestmentIncomeOperating',
target='GrossProfit'),
CopyTagRule(original='InterestAndDividendIncomeOperating',
target='GrossProfit')])
]
)
is_missing_gross_opil_opexp = RuleGroup(
prefix="GrossOpILOpExp_missing",
description="Calculates the third tag, if two of GrossProfit, OperatingExpenses, "
"and OperatingIncomeLoss are present",
rules=missingsumparts_rules_creator(sum_tag='GrossProfit',
summand_tags=['OperatingExpenses',
'OperatingIncomeLoss']))
# this rule has to follow after the previous rule:
# first prio is to try to calc OperatingExpenses from GrossProfit-OperatingIncomeLoss
# second, we try to calculat OperatingExpenses from the 100 top used operating costs
# and then maybe use it in the next iteration to calculate GrossProfit or OpIncLoss
# with the previous rule
is_operating_expenses_rg = RuleGroup(
prefix="OperatingExpenses",
rules=[
RuleGroup(prefix="Pre",
description="Preparation rules which might be usable to estimate "
"OperatingExpenses",
rules=[
SumUpRule(sum_tag='OperatingExpensesSum',
potential_summands=top_100_operating_costs_tags)]),
RuleGroup(prefix="Set",
description="Rules that might set the OperatingExpenses tag."
"The order is the precedence",
rules=[
CopyTagRule(original='OperatingExpensesSum', target='OperatingExpenses')])
])
is_inclossbeforetax = RuleGroup(
prefix="inclossbeforetax",
rules=[
RuleGroup(prefix="Pre",
description="Preparation rules which might be usable to estimate "
"IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit",
rules=[
SumUpRule(
sum_tag='IncomeLossFromContinuingOperationsFromEquityMethodInvestements',
potential_summands=[
'IncomeLossFromContinuingOperationsBeforeIncomeTaxesMinorityInterestAndIncomeLossFromEquityMethodInvestments',
], optional_summands=['IncomeLossFromEquityMethodInvestments']),
]),
RuleGroup(prefix="Set",
description="Rules that might set the "
"IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit"
" tag. The order is the precedence",
rules=[
# Renaming
CopyTagRule(
original='IncomeLossFromContinuingOperationsBeforeIncomeTaxesExtraordinaryItemsNoncontrollingInterest',
target='IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit'),
CopyTagRule(
original='IncomeLossFromContinuingOperationsFromEquityMethodInvestements',
target='IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit'),
])
])
is_netincome_rg = RuleGroup(
prefix="netincome",
rules=[
RuleGroup(prefix="Pre",
description="Preparation rules which might be usable to estimate "
"NetIncomeLoss, ProfitLoss, and IncomeLossFromContinuingOperations",
rules=[
SumUpRule(
sum_tag='AllIncomeTaxExpenseBenefit',
potential_summands=[
'IncomeTaxExpenseBenefit', 'DeferredIncomeTaxExpenseBenefit'
], optional_summands=['IncomeLossFromEquityMethodInvestments']),
CopyTagRule(
original='IncomeLossFromContinuingOperationsIncludingPortionAttributableToNoncontrollingInterest',
target='IncomeLossFromContinuingOperations'),
SubtractFromRule(
target_tag='IncomeLossFromContinuingOperations',
subtract_from_tag='IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit',
potential_subtract_tags=['AllIncomeTaxExpenseBenefit']
),
CopyTagRule(
original='IncomeLossFromDiscontinuedOperationsNetOfTaxAttributableToReportingEntity',
target='IncomeLossFromDiscontinuedOperationsNetOfTax'),
SumUpRule(sum_tag='ProfitLossParts',
potential_summands=[
'IncomeLossFromContinuingOperations',
'IncomeLossFromDiscontinuedOperationsNetOfTax'
])
]),
RuleGroup(prefix="SetPL",
description="Rules that might set the ProfitLoss tag."
"The order is the precedence",
rules=[
CopyTagRule(original='ProfitLossParts', target='ProfitLoss'),
# if there is no value for ProfitLoss, we set it to NetIncomeLoss
CopyTagRule(original='NetIncomeLoss', target='ProfitLoss')]),
RuleGroup(prefix="SetILContOp",
description="Rules that might set the IncomeLossFromContinuingOperations tag."
"The order is the precedence",
rules=[
# since IncomeLossFromContinuingOperations is part of a validation rule,
# and if it was not set, we assume that there is only
# IncomeLossFromContinuingOperations and
# copy the value from ProfitLoss
CopyTagRule(original='ProfitLoss',
target='IncomeLossFromContinuingOperations')
]),
# the following rules set the NetIncomeLoss, if not already set.
# the order of the rules is the precedence
RuleGroup(prefix="SetNIL",
description="Rules that might set the NetIncomeLoss tag."
"The order is the precedence",
rules=[
CopyTagRule(original='NetIncomeLossAvailableToCommonStockholdersBasic',
target='NetIncomeLoss'),
CopyTagRule(original='NetIncomeLossAllocatedToLimitedPartners',
target='NetIncomeLoss'),
CopyTagRule(original='ProfitLoss', target='NetIncomeLoss'),
CopyTagRule(
original='ProfitLossIncludingRedeemableNonControllingInterest',
target='NetIncomeLoss'),
CopyTagRule(original='OtherComprehensiveIncomeLossNetOfTax',
target='NetIncomeLoss'),
CopyTagRule(original='ComprehensiveIncomeNetOfTax',
target='NetIncomeLoss'),
CopyTagRule(original='IncomeLossAttributableToParent',
target='NetIncomeLoss'),
# for investment companies
CopyTagRule(original='NetInvestmentIncome', target='NetIncomeLoss'),
])
]
)
is_missing_ilbefore_tax_ilcontop = RuleGroup(
prefix="inclossbefore_tax_inclossop_missing",
description="Calculates the third tag, if two of AllIncomeTaxExpenseBenefit,"
" IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit, "
"and IncomeLossFromContinuingOperations are present",
rules=missingsumparts_rules_creator(
sum_tag='IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit',
summand_tags=['IncomeLossFromContinuingOperations',
'AllIncomeTaxExpenseBenefit'])
)
is_missing_nilattnoncnt = MissingSummandRule(
sum_tag='ProfitLoss',
existing_summands_tags=['NetIncomeLoss'],
missing_summand_tag='NetIncomeLossAttributableToNoncontrollingInterest'
)
is_outstandingshares = RuleGroup(
prefix="sharesAndEPS",
description="Rules to extract the number of shares",
rules=[
CopyTagRule(target='OutstandingShares',
original='WeightedAverageNumberOfSharesOutstandingBasic'),
CopyTagRule(target='OutstandingShares',
original='WeightedAverageNumberOfDilutedSharesOutstanding'),
CopyTagRule(target='OutstandingShares',
original='WeightedAverageNumberOfShareOutstandingBasicAndDiluted'),
CopyTagRule(target='OutstandingShares',
original='WeightedAverageLimitedPartnershipUnitsOutstanding'),
CopyTagRule(target='OutstandingShares',
original='WeightedAverageLimitedPartnershipUnitsOutstandingDiluted'),
CopyTagRule(target='OutstandingShares',
original='WeightedAverageNumberOfLimitedPartnershipAndGeneralPartnershipUnitOutstandingBasicAndDiluted'),
CopyTagRule(target='OutstandingShares',
original='WeightedAverageGeneralPartnershipUnitsOutstanding'),
CopyTagRule(target='EarningsPerShare',
original='EarningsPerShareBasic'),
CopyTagRule(target='EarningsPerShare',
original='EarningsPerShareDiluted'),
CopyTagRule(target='EarningsPerShare',
original='EarningsPerShareBasicAndDiluted'),
CopyTagRule(target='EarningsPerShare',
original='IncomeLossFromContinuingOperationsPerBasicShare'),
CopyTagRule(target='EarningsPerShare',
original='IncomeLossFromContinuingOperationsPerDilutedShare'),
CopyTagRule(target='EarningsPerShare',
original='IncomeLossFromContinuingOperationsPerBasicAndDilutedShare'),
CopyTagRule(target='EarningsPerShare',
original='IncomeLossFromContinuingOperationsPerOutstandingLimitedPartnershipUnit'),
CopyTagRule(target='EarningsPerShare',
original='IncomeLossFromContinuingOperationsPerOutstandingLimitedPartnershipUnitBasicNetOfTax'),
CopyTagRule(target='EarningsPerShare',
original='IncomeLossFromContinuingOperationsPerOutstandingLimitedPartnershipAndGeneralPartnershipUnitBasicAndDiluted'),
]
)
main_rule_tree = RuleGroup(prefix="IS",
rules=[
is_revenue_rg,
is_costofrevenue_rg,
is_missing_rev_cost_gross,
is_grossprofit_rg,
is_missing_gross_opil_opexp,
is_operating_expenses_rg,
is_inclossbeforetax,
is_netincome_rg,
is_missing_ilbefore_tax_ilcontop,
is_missing_nilattnoncnt,
is_outstandingshares
])
preprocess_rule_tree = RuleGroup(prefix="IS_PRE",
rules=[
])
post_rule_tree = RuleGroup(
prefix="IS",
rules=[
PostFixIncomeLossFromContinuingOperationsAndSignOfIncomeTaxExpenseBenefit(),
PostFixSign(start_tag='ProfitLoss',
summand_tag='AllIncomeTaxExpenseBenefit',
result_tag='IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit'),
PostFixSign(start_tag='NetIncomeLoss',
summand_tag='NetIncomeLossAttributableToNoncontrollingInterest',
result_tag='ProfitLoss'),
# 1. if there is no value for Revenues, but GrossProfit
# we set Revenues to GrossProfit
# 2. if there is no value for GrossProfit, but Revenues
# we set GrossProfit to Revenues
# 3. in both cases, CostOfRevenue is set to zero with the following
# MissingSummandRule.
CopyTagRule(original='GrossProfit', target='Revenues'),
CopyTagRule(original='Revenues', target='GrossProfit'),
MissingSummandRule(sum_tag='Revenues',
existing_summands_tags=['GrossProfit'],
missing_summand_tag='CostOfRevenue'),
# Next, we finalize OperatingIncomeLoss, by subtracting
# a last time the OperatingExpenses from the GrossProfit,
# if OperatingIncomeLoss is not yet set
SubtractFromRule(subtract_from_tag='GrossProfit',
potential_subtract_tags=['OperatingExpenses'],
target_tag='OperatingIncomeLoss'),
# 1. if there is no value for IncomeLossFromContinuingOperations,
# but for ProfitLoss, we set it to the same value
# 2. if there is no value for IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit,
# but for IncomeLossFromContinuingOperations, we set it to the same value
# 3. afterward, we set IncomeTaxExpenseBenefit to zero with the following rule
CopyTagRule(original='ProfitLoss',
target='IncomeLossFromContinuingOperations'),
CopyTagRule(original='IncomeLossFromContinuingOperations',
target='IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit'),
MissingSummandRule(
sum_tag='IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit',
existing_summands_tags=['IncomeLossFromContinuingOperations'],
missing_summand_tag='AllIncomeTaxExpenseBenefit'),
# if there is no "IncomeLossFromDiscontinuedOperationsNetOfTax", set it to 0
PostSetToZero(tags=['IncomeLossFromDiscontinuedOperationsNetOfTax']),
# if IncomeLossFromContinuingOperations is not set, but IL..BeforeIncomeTaxExpenseBenefit is set
# set it to IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit
CopyTagRule(original='IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit',
target='IncomeLossFromContinuingOperations'),
# since new IncomeLossFromContinuingOperations values could have been set,
# calculate missing ProfitLoss entries, if possible
SumUpRule(sum_tag='ProfitLoss',
potential_summands=[
'IncomeLossFromContinuingOperations',
'IncomeLossFromDiscontinuedOperationsNetOfTax'
]),
# since new ProfitLoss could have been set, use it to set still missing NetIncomeLoss
CopyTagRule(original='ProfitLoss',
target='NetIncomeLoss'),
# calculate missing NetIncomeLossAttributableToNoncontrollingInterest
# which at this point will mean to set it to 0.
MissingSummandRule(
sum_tag='ProfitLoss',
existing_summands_tags=['NetIncomeLoss'],
missing_summand_tag='NetIncomeLossAttributableToNoncontrollingInterest'),
])
validation_rules: List[ValidationRule] = [
SumValidationRule(identifier="RevCogGrossCheck",
sum_tag='Revenues',
summands=['CostOfRevenue', 'GrossProfit']),
SumValidationRule(identifier="GrossOpexpOpil",
sum_tag='GrossProfit',
summands=['OperatingExpenses', 'OperatingIncomeLoss']),
SumValidationRule(identifier="ContIncTax",
sum_tag='IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit',
summands=['AllIncomeTaxExpenseBenefit',
'IncomeLossFromContinuingOperations']),
SumValidationRule(identifier='ProfitLoss',
sum_tag='ProfitLoss',
summands=[
'IncomeLossFromContinuingOperations',
'IncomeLossFromDiscontinuedOperationsNetOfTax'
]),
SumValidationRule(identifier='NetIncomeLoss',
sum_tag='ProfitLoss',
summands=[
'NetIncomeLoss',
'NetIncomeLossAttributableToNoncontrollingInterest'
]),
ProductValidationRule(identifier='EPS',
product_tag='NetIncomeLoss',
multipliers=['EarningsPerShare',
'OutstandingShares']),
]
# these are the columns that finally are returned after the standardization
final_tags: List[str] = ['Revenues',
'CostOfRevenue',
'GrossProfit',
'OperatingExpenses',
'OperatingIncomeLoss',
'IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit',
'AllIncomeTaxExpenseBenefit',
'IncomeLossFromContinuingOperations',
'IncomeLossFromDiscontinuedOperationsNetOfTax',
'ProfitLoss',
'NetIncomeLossAttributableToNoncontrollingInterest',
'NetIncomeLoss',
'OutstandingShares',
'EarningsPerShare'
]
# used to evaluate if a report is the main income statement report
# inside a report, there can be several tables (different report nr)
# which stmt value is IS.
# however, we might be only interested in the "major" IS report. Usually this is the
# one which has the least nan in the following columns
main_statement_tags = ['Revenues',
'SalesRevenueNet',
'SalesRevenueGoodsNet',
'SalesRevenueServicesNet',
'CostOfRevenue',
'CostOfGoodsAndServicesSold',
'CostOfGoodsSold',
'CostOfServices',
'GrossProfit',
'OperatingExpenses',
'OperatingIncomeLoss',
'IncomeLossFromContinuingOperationsBeforeIncomeTaxesMinorityInterestAndIncomeLossFromEquityMethodInvestments',
'IncomeLossFromContinuingOperationsBeforeIncomeTaxesExtraordinaryItemsNoncontrollingInterest',
'IncomeLossBeforeIncomeTaxExpenseBenefit',
'IncomeTaxExpenseBenefit',
'DeferredIncomeTaxExpenseBenefit',
'NetIncomeLoss',
'ProfitLoss'
]
def __init__(self,
prepivot_rule_tree: Optional[RuleGroup] = None,
pre_rule_tree: Optional[RuleGroup] = None,
main_rule_tree: Optional[RuleGroup] = None,
post_rule_tree: Optional[RuleGroup] = None,
validation_rules: Optional[List[ValidationRule]] = None,
final_tags: Optional[List[str]] = None,
main_statement_tags: Optional[List[str]] = None,
filter_for_main_statement: bool = True,
main_iterations: int = 3,
invert_negated: bool = True,
additional_final_sub_fields: Optional[List[str]] = None,
additional_final_tags: Optional[List[str]] = None):
"""
Initialize the Income Statement Standardizer.
Fine tune it with the following arguments:
Args:
prepivot_rule_tree: rules that are applied before the data is pivoted. These are rules
that pathfilter (like deduplicate) or correct values.
pre_rule_tree: rules that are applied once before the main processing. These are mainly
rules that try to correct existing data from obvious errors (like wrong
tagging)
main_rule_tree: rules that are applied during the main processing rule and which do the
heavy lifting. These rules can be executed multiple times depending on the value
of the main_iterations parameter
post_rule_tree: rules that are used to "cleanup", like setting certain values to
0.0. They are just executed once.
validation_rules: Validation rules are applied after all rules were applied.
they add validation columns to the main dataset. Validation rules do check
if certain requirements are met. E.g. in a Balance Sheet, the following
equation should be true: Assets = AssetsCurrent + AssetsNoncurrent
final_tags: The list of tags/columns that will appear in the final result dataframe.
main_statement_tags: list of tags that is used to identify the main table of a
financial statement (income statement, balance sheet, cash flow).
filter_for_main_statement (bool):
Only consider the reports that contain most of the "main_statement_tags".
Default is True.
main_iterations (int): Number of times the main rules should be applied.
Default is 3 for CashFlow.
invert_negated (bool, Optional, True): inverts the value of the tags that are marked
as negated (in the pre_df).
additional_final_sub_fields (List, Optional):
When using the present method, the results are joined with the following fields
from the sub_df entry: 'adsh', 'cik', 'form', 'fye', 'fy', 'fp', 'filed'
Additional fields can be assigned in this list. Default is None.
additional_final_tags (List, Optional):
the "final_tags" list define the tags that will be present in the final result
dataframe. Additional tags can be added via this parameter. Default is None.
"""
super().__init__(
prepivot_rule_tree=
prepivot_rule_tree if prepivot_rule_tree else self.prepivot_rule_tree,
pre_rule_tree=pre_rule_tree if pre_rule_tree else self.preprocess_rule_tree,
main_rule_tree=main_rule_tree if main_rule_tree else self.main_rule_tree,
post_rule_tree=post_rule_tree if post_rule_tree else self.post_rule_tree,
validation_rules=validation_rules if validation_rules else self.validation_rules,
final_tags=final_tags if final_tags else self.final_tags,
main_statement_tags=
main_statement_tags if main_statement_tags else self.main_statement_tags,
filter_for_main_statement=filter_for_main_statement,
main_iterations=main_iterations,
invert_negated=invert_negated,
additional_final_sub_fields=additional_final_sub_fields,
additional_final_tags=additional_final_tags
)Classes
class IncomeStatementStandardizer (prepivot_rule_tree: Optional[RuleGroup] = None, pre_rule_tree: Optional[RuleGroup] = None, main_rule_tree: Optional[RuleGroup] = None, post_rule_tree: Optional[RuleGroup] = None, validation_rules: Optional[List[ValidationRule]] = None, final_tags: Optional[List[str]] = None, main_statement_tags: Optional[List[str]] = None, filter_for_main_statement: bool = True, main_iterations: int = 3, invert_negated: bool = True, additional_final_sub_fields: Optional[List[str]] = None, additional_final_tags: Optional[List[str]] = None)-
The goal of this Standardizer is to create IncomeStatements that are comparable, meaning that they have the same tags.
At the end, the standardized IS contains the following columns
Revenues - CostOfRevenue --------------- = GrossProfit - OperatingExpenses ------------------- = OperatingIncomeLoss IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit - AllIncomeTaxExpenseBenefit ---------------------------- = IncomeLossFromContinuingOperations + IncomeLossFromDiscontinuedOperationsNetOfTax ----------------------------------------------- = ProfitLoss - NetIncomeLossAttributableToNoncontrollingInterest --------------------------------------------------- = NetIncomeLossDetailled View:
Main Rules Revenues: Pre + SalesRevenueGoodsNet <- SalesRevenueGoodsGross + SalesRevenueServicesNet <- SalesRevenueServicesGross + OtherSalesRevenueNet -------------- = SalesRevenueNet RevenueFromContractWithCustomerIncludingAssessedTax - ExciseAndSalesTaxes --------------------- = RevenueFromContractWithCustomerExcludingAssessedTax + RegulatedAndUnregulatedOperatingRevenue + HealthCareOrganizationPatientServiceRevenue + ContractsRevenue + RevenueOilAndGasServices ... ------------------ = RevenuesSum Set 1. Prio: Revenues 2. Prio: SalesRevenueNet 3. Prio: RevenueFromContractWithCustomerExcludingAssessedTax 4. Prio: RevenueFromContractWithCustomerIncludingAssessedTax 5. Prio: RevenuesExcludingInterestAndDividends 6. Prio: RevenuesSum 7. Prio: InvestmentIncomeInterest 8. Prio: CostOfRevenue + GrossProfit CostOfRevenue Pre + CostOfGoodsSoldExcludingDepreciationDepletionAndAmortization + CostOfGoodsSoldDepreciationDepletionAndAmortization + CostOfGoodsSoldDepletion + CostOfGoodsSoldDepreciation + ... ------------ = CostOfGoodsSold (if not set) + CostOfServicesExcludingDepreciationDepletionAndAmortization + CostOfServicesDepreciation + CostOfServicesDepreciationAndAmortization + CostOfServicesCatering + ... ------------ = CostOfServices (if not set) + CostOfGoodsAndServicesSoldDepreciationAndAmortization + CostOfGoodsAndServicesSoldAmortization + CostOfGoodsAndServicesSoldOverhead + CostOfGoodsAndServicesSoldDepreciation + CostOfGoodsAndServicesEnergyCommoditiesAndServices + CostOfGoodsAndServiceExcludingDepreciationDepletionAndAmortizatio ------------ = CostOfGoodsAndServicesSold (if not set) CostOfGoodsSold + CostOfServices --------------- = CostOfGoodsAndServicesSold (if not set) Set 1. Prio CostOfRevenue 2. Prio CostOfGoodsAndServicesSold 3. Prio Revenues - GrossProfit GrossProfit 1. Prio GrossProfit 2. Prio Revenues - CostOfRevenue 3. Prio GrossInvestmentIncomeOperating 4. Prio InterestAndDividendIncomeOperating OperatingExpenses Pre + SellingGeneralAndAdministrativeExpense + GeneralAndAdministrativeExpense + ResearchAndDevelopmentExpense + SellingAndMarketingExpense + ... (96 most expense tags) ---------------------------- = OperatingExpensesSum Set 1. Prio OperatingExpenses 2. Prio GrossProfit - OperatingIncomeLoss 3. Prio OperatingExpensesSum OperatingIncomeLoss Set 1. Prio OperatingIncomeLoss 2. Prio GrossProfit - OperatingExpenses IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit Pre + IncomeLossFromContinuingOperationsBeforeIncomeTaxesMinorityInterestAndIncomeLossFromEquityMethodInvestments + (Optional) IncomeLossFromEquityMethodInvestments -------------------------------------------------- = IncomeLossFromContinuingOperationsFromEquityMethodInvestements Set 1. Prio IncomeLossFromContinuingOperationsBeforeIncomeTaxesExtraordinaryItemsNoncontrollingInterest rename 2. Prio IncomeLossFromContinuingOperationsFromEquityMethodInvestements 3. Prio IncomeLossFromContinuingOperations + AllIncomeTaxExpenseBenefit NetIncome Pre + IncomeTaxExpenseBenefit + DeferredIncomeTaxExpenseBenefit + (optional) IncomeLossFromEquityMethodInvestments --------------------------------- = AllIncomeTaxExpenseBenefit IncomeLossFromContinuingOperations <- (rename) IncomeLossFromContinuingOperationsIncludingPortionAttributableToNoncontrollingInterest IncomeLossFromDiscontinuedOperationsNetOfTax <- (rename) IncomeLossFromDiscontinuedOperationsNetOfTaxAttributableToReportingEntity + IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit - AllIncomeTaxExpenseBenefit --------------------------------- = IncomeLossFromContinuingOperations + IncomeLossFromContinuingOperations + IncomeLossFromDiscontinuedOperationsNetOfTax ------------------------- = ProfitLossParts SetProfitLoss 1. Prio ProfitLoss 2. Prio ProfitLossParts 3. Prio NetIncomeLoss SetIncomeLossContinuingOperations 3. Prio ProfitLoss SetNetIncomeLoss 1. Prio NetIncomeLoss 2. Prio NetIncomeLossAvailableToCommonStockholdersBasic 3. Prio NetIncomeLossAllocatedToLimitedPartners 3. Prio ProfitLoss 4. Prio ProfitLossIncludingRedeemableNonControllingInterest 5. Prio OtherComprehensiveIncomeLossNetOfTax 6. Prio ComprehensiveIncomeNetOfTax 7. Prio IncomeLossAttributableToParent 8. Prio NetInvestmentIncome OutstandingShares 1. Prio WeightedAverageNumberOfSharesOutstandingBasic 2. Prio WeightedAverageNumberOfDilutedSharesOutstanding 3. Prio WeightedAverageNumberOfShareOutstandingBasicAndDiluted 4. Prio WeightedAverageLimitedPartnershipUnitsOutstanding 5. Prio WeightedAverageLimitedPartnershipUnitsOutstandingDiluted 6. Prio WeightedAverageNumberOfLimitedPartnershipAndGeneralPartnershipUnitOutstandingBasicAndDiluted 7. Prio WeightedAverageGeneralPartnershipUnitsOutstanding EarningsPerShare 1. Prio EarningsPerShareBasic 2. Prio EarningsPerShareDiluted 3. Prio EarningsPerShareBasicAndDiluted 4. Prio IncomeLossFromContinuingOperationsPerBasicShare 5. Prio IncomeLossFromContinuingOperationsPerDilutedShare 6. Prio IncomeLossFromContinuingOperationsPerBasicAndDilutedShare 7. Prio IncomeLossFromContinuingOperationsPerOutstandingLimitedPartnershipUnit 8. Prio IncomeLossFromContinuingOperationsPerOutstandingLimitedPartnershipUnitBasicNetOfTax 9. Prio IncomeLossFromContinuingOperationsPerOutstandingLimitedPartnershipAndGeneralPartnershipUnitBasicAndDiluted Post Rule (Cleanup) Fix Sign of AllIncomeTaxExpenseBenefit (should be positive if taxed were paid) expected equation to be true: IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit - AllIncomeTaxExpenseBenefit = ProfitLoss invert sign of AllIncomeTaxExpenseBenefit if the following equation is true: IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit + AllIncomeTaxExpenseBenefit = ProfitLoss Fix sign of NetIncomeLossAttributableToNoncontrollingInterest expected equation to be true: ProfitLoss - NetIncomeLossAttributableToNoncontrollingInterest = NetIncomeLoss invert sign of NetIncomeLossAttributableToNoncontrollingInterest if the following equation is true: ProfitLoss + NetIncomeLossAttributableToNoncontrollingInterest = NetIncomeLoss If Revenues was not set, but there is a GrossProfit, set it to GrossProfit, since was no CostOfRevenue found If GrossProfit couldn't be set, but there is Revenues, set it to Revenues since was no CostOfRevenue found if CostORevenues couldn't be set, but Revenues and GrossProfit are present, set it to Revenues - Grossprofit if OperatingIncomeLoss is not set yet, and GrossProfit (available now) and OperatingExpenses are present, set it to GrossProfit - OperatingExpenses If there is no IncomeLossFromContinuingOperations, set it to ProfitLoss if there is no IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit, set it to IncomeLossFromContinuingOperations if there is no AllIncomeTaxExpenseBenefit, set it to IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit - AllIncomeTaxExpenseBenefit set IncomeLossFromDiscontinuedOperationsNetOfTax to 0.0 if not present If there is no IncomeLossFromContinuingOperations, set it to IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit If there is no ProfitLoss, set it to IncomeLossFromContinuingOperations + IncomeLossFromDiscontinuedOperationsNetOfTax If there is no NetIncomeLoss, set it to ProfitLoss If there is no NetIncomeLossAttributableToNoncontrollingInterest, set it to ProfitLoss - NetIncomeLossInitialize the Income Statement Standardizer.
Fine tune it with the following arguments:
Args
prepivot_rule_tree- rules that are applied before the data is pivoted. These are rules that pathfilter (like deduplicate) or correct values.
pre_rule_tree- rules that are applied once before the main processing. These are mainly rules that try to correct existing data from obvious errors (like wrong tagging)
main_rule_tree- rules that are applied during the main processing rule and which do the heavy lifting. These rules can be executed multiple times depending on the value of the main_iterations parameter
post_rule_tree- rules that are used to "cleanup", like setting certain values to 0.0. They are just executed once.
validation_rules- Validation rules are applied after all rules were applied. they add validation columns to the main dataset. Validation rules do check if certain requirements are met. E.g. in a Balance Sheet, the following equation should be true: Assets = AssetsCurrent + AssetsNoncurrent
final_tags- The list of tags/columns that will appear in the final result dataframe.
main_statement_tags- list of tags that is used to identify the main table of a financial statement (income statement, balance sheet, cash flow).
- filter_for_main_statement (bool):
- Only consider the reports that contain most of the "main_statement_tags".
- Default is True.
main_iterations:int- Number of times the main rules should be applied. Default is 3 for CashFlow.
invert_negated:bool, Optional, True- inverts the value of the tags that are marked as negated (in the pre_df).
additional_final_sub_fields (List, Optional): When using the present method, the results are joined with the following fields from the sub_df entry: 'adsh', 'cik', 'form', 'fye', 'fy', 'fp', 'filed' Additional fields can be assigned in this list. Default is None. additional_final_tags (List, Optional): the "final_tags" list define the tags that will be present in the final result dataframe. Additional tags can be added via this parameter. Default is None.
Expand source code
class IncomeStatementStandardizer(Standardizer): """ The goal of this Standardizer is to create IncomeStatements that are comparable, meaning that they have the same tags. At the end, the standardized IS contains the following columns <pre> Revenues - CostOfRevenue --------------- = GrossProfit - OperatingExpenses ------------------- = OperatingIncomeLoss IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit - AllIncomeTaxExpenseBenefit ---------------------------- = IncomeLossFromContinuingOperations + IncomeLossFromDiscontinuedOperationsNetOfTax ----------------------------------------------- = ProfitLoss - NetIncomeLossAttributableToNoncontrollingInterest --------------------------------------------------- = NetIncomeLoss </pre> Detailled View: <pre> Main Rules Revenues: Pre + SalesRevenueGoodsNet <- SalesRevenueGoodsGross + SalesRevenueServicesNet <- SalesRevenueServicesGross + OtherSalesRevenueNet -------------- = SalesRevenueNet RevenueFromContractWithCustomerIncludingAssessedTax - ExciseAndSalesTaxes --------------------- = RevenueFromContractWithCustomerExcludingAssessedTax + RegulatedAndUnregulatedOperatingRevenue + HealthCareOrganizationPatientServiceRevenue + ContractsRevenue + RevenueOilAndGasServices ... ------------------ = RevenuesSum Set 1. Prio: Revenues 2. Prio: SalesRevenueNet 3. Prio: RevenueFromContractWithCustomerExcludingAssessedTax 4. Prio: RevenueFromContractWithCustomerIncludingAssessedTax 5. Prio: RevenuesExcludingInterestAndDividends 6. Prio: RevenuesSum 7. Prio: InvestmentIncomeInterest 8. Prio: CostOfRevenue + GrossProfit CostOfRevenue Pre + CostOfGoodsSoldExcludingDepreciationDepletionAndAmortization + CostOfGoodsSoldDepreciationDepletionAndAmortization + CostOfGoodsSoldDepletion + CostOfGoodsSoldDepreciation + ... ------------ = CostOfGoodsSold (if not set) + CostOfServicesExcludingDepreciationDepletionAndAmortization + CostOfServicesDepreciation + CostOfServicesDepreciationAndAmortization + CostOfServicesCatering + ... ------------ = CostOfServices (if not set) + CostOfGoodsAndServicesSoldDepreciationAndAmortization + CostOfGoodsAndServicesSoldAmortization + CostOfGoodsAndServicesSoldOverhead + CostOfGoodsAndServicesSoldDepreciation + CostOfGoodsAndServicesEnergyCommoditiesAndServices + CostOfGoodsAndServiceExcludingDepreciationDepletionAndAmortizatio ------------ = CostOfGoodsAndServicesSold (if not set) CostOfGoodsSold + CostOfServices --------------- = CostOfGoodsAndServicesSold (if not set) Set 1. Prio CostOfRevenue 2. Prio CostOfGoodsAndServicesSold 3. Prio Revenues - GrossProfit GrossProfit 1. Prio GrossProfit 2. Prio Revenues - CostOfRevenue 3. Prio GrossInvestmentIncomeOperating 4. Prio InterestAndDividendIncomeOperating OperatingExpenses Pre + SellingGeneralAndAdministrativeExpense + GeneralAndAdministrativeExpense + ResearchAndDevelopmentExpense + SellingAndMarketingExpense + ... (96 most expense tags) ---------------------------- = OperatingExpensesSum Set 1. Prio OperatingExpenses 2. Prio GrossProfit - OperatingIncomeLoss 3. Prio OperatingExpensesSum OperatingIncomeLoss Set 1. Prio OperatingIncomeLoss 2. Prio GrossProfit - OperatingExpenses IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit Pre + IncomeLossFromContinuingOperationsBeforeIncomeTaxesMinorityInterestAndIncomeLossFromEquityMethodInvestments + (Optional) IncomeLossFromEquityMethodInvestments -------------------------------------------------- = IncomeLossFromContinuingOperationsFromEquityMethodInvestements Set 1. Prio IncomeLossFromContinuingOperationsBeforeIncomeTaxesExtraordinaryItemsNoncontrollingInterest rename 2. Prio IncomeLossFromContinuingOperationsFromEquityMethodInvestements 3. Prio IncomeLossFromContinuingOperations + AllIncomeTaxExpenseBenefit NetIncome Pre + IncomeTaxExpenseBenefit + DeferredIncomeTaxExpenseBenefit + (optional) IncomeLossFromEquityMethodInvestments --------------------------------- = AllIncomeTaxExpenseBenefit IncomeLossFromContinuingOperations <- (rename) IncomeLossFromContinuingOperationsIncludingPortionAttributableToNoncontrollingInterest IncomeLossFromDiscontinuedOperationsNetOfTax <- (rename) IncomeLossFromDiscontinuedOperationsNetOfTaxAttributableToReportingEntity + IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit - AllIncomeTaxExpenseBenefit --------------------------------- = IncomeLossFromContinuingOperations + IncomeLossFromContinuingOperations + IncomeLossFromDiscontinuedOperationsNetOfTax ------------------------- = ProfitLossParts SetProfitLoss 1. Prio ProfitLoss 2. Prio ProfitLossParts 3. Prio NetIncomeLoss SetIncomeLossContinuingOperations 3. Prio ProfitLoss SetNetIncomeLoss 1. Prio NetIncomeLoss 2. Prio NetIncomeLossAvailableToCommonStockholdersBasic 3. Prio NetIncomeLossAllocatedToLimitedPartners 3. Prio ProfitLoss 4. Prio ProfitLossIncludingRedeemableNonControllingInterest 5. Prio OtherComprehensiveIncomeLossNetOfTax 6. Prio ComprehensiveIncomeNetOfTax 7. Prio IncomeLossAttributableToParent 8. Prio NetInvestmentIncome OutstandingShares 1. Prio WeightedAverageNumberOfSharesOutstandingBasic 2. Prio WeightedAverageNumberOfDilutedSharesOutstanding 3. Prio WeightedAverageNumberOfShareOutstandingBasicAndDiluted 4. Prio WeightedAverageLimitedPartnershipUnitsOutstanding 5. Prio WeightedAverageLimitedPartnershipUnitsOutstandingDiluted 6. Prio WeightedAverageNumberOfLimitedPartnershipAndGeneralPartnershipUnitOutstandingBasicAndDiluted 7. Prio WeightedAverageGeneralPartnershipUnitsOutstanding EarningsPerShare 1. Prio EarningsPerShareBasic 2. Prio EarningsPerShareDiluted 3. Prio EarningsPerShareBasicAndDiluted 4. Prio IncomeLossFromContinuingOperationsPerBasicShare 5. Prio IncomeLossFromContinuingOperationsPerDilutedShare 6. Prio IncomeLossFromContinuingOperationsPerBasicAndDilutedShare 7. Prio IncomeLossFromContinuingOperationsPerOutstandingLimitedPartnershipUnit 8. Prio IncomeLossFromContinuingOperationsPerOutstandingLimitedPartnershipUnitBasicNetOfTax 9. Prio IncomeLossFromContinuingOperationsPerOutstandingLimitedPartnershipAndGeneralPartnershipUnitBasicAndDiluted Post Rule (Cleanup) Fix Sign of AllIncomeTaxExpenseBenefit (should be positive if taxed were paid) expected equation to be true: IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit - AllIncomeTaxExpenseBenefit = ProfitLoss invert sign of AllIncomeTaxExpenseBenefit if the following equation is true: IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit + AllIncomeTaxExpenseBenefit = ProfitLoss Fix sign of NetIncomeLossAttributableToNoncontrollingInterest expected equation to be true: ProfitLoss - NetIncomeLossAttributableToNoncontrollingInterest = NetIncomeLoss invert sign of NetIncomeLossAttributableToNoncontrollingInterest if the following equation is true: ProfitLoss + NetIncomeLossAttributableToNoncontrollingInterest = NetIncomeLoss If Revenues was not set, but there is a GrossProfit, set it to GrossProfit, since was no CostOfRevenue found If GrossProfit couldn't be set, but there is Revenues, set it to Revenues since was no CostOfRevenue found if CostORevenues couldn't be set, but Revenues and GrossProfit are present, set it to Revenues - Grossprofit if OperatingIncomeLoss is not set yet, and GrossProfit (available now) and OperatingExpenses are present, set it to GrossProfit - OperatingExpenses If there is no IncomeLossFromContinuingOperations, set it to ProfitLoss if there is no IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit, set it to IncomeLossFromContinuingOperations if there is no AllIncomeTaxExpenseBenefit, set it to IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit - AllIncomeTaxExpenseBenefit set IncomeLossFromDiscontinuedOperationsNetOfTax to 0.0 if not present If there is no IncomeLossFromContinuingOperations, set it to IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit If there is no ProfitLoss, set it to IncomeLossFromContinuingOperations + IncomeLossFromDiscontinuedOperationsNetOfTax If there is no NetIncomeLoss, set it to ProfitLoss If there is no NetIncomeLossAttributableToNoncontrollingInterest, set it to ProfitLoss - NetIncomeLoss </pre> """ prepivot_rule_tree = RuleGroup( prefix="IS_PREPIV", rules=[PrePivotDeduplicate(), PrePivotMaxQtrs(max_qtrs=4), PrePivotCorrectSign( # all these tags are costOf and therefore should appear as a positive number # since costs are subtracted from the Revenue to get the GrossProfit tag_list=cost_of_GaS_tags, is_positive=True )] ) is_revenue_rg = RuleGroup( prefix="Rev", rules=[ RuleGroup(prefix="Pre", description="Preparation rules which might be usable to estimate the revenue", rules=[ # normally, (Goods and Services) Gross and Net appear together, resp. Net has priority. # so if net is not present, we copy the gross value in the net value # and then sum the nets up to the SalesRevenue CopyTagRule( original='SalesRevenueGoodsGross', target='SalesRevenueGoodsNet'), CopyTagRule( original='SalesRevenueServicesGross', target='SalesRevenueServicesNet'), SumUpRule(sum_tag='SalesRevenueNet', potential_summands=[ 'SalesRevenueGoodsNet', 'SalesRevenueServicesNet'], optional_summands=[ 'OtherSalesRevenueNet' ]), # RevenueFromContractWithCustomer-tags are also often used to report the # total Revenue. so the following rules take care of these cases. # the order of the rules also defines the precedence. # first: if RevenueFromContractWithCustomerExcludingAssessedTax is not set # we calculate it from RevenueFromContractWithCustomerIncludingAssessedTax # and ExciseAndSalesTaxes (if present) SubtractFromRule( subtract_from_tag='RevenueFromContractWithCustomerIncludingAssessedTax', potential_subtract_tags=['ExciseAndSalesTaxes'], target_tag='RevenueFromContractWithCustomerExcludingAssessedTax'), # if we were not able to define the Revenue so far, there are # a couple of other tags which define Revenue, so we count them together # and set the total as Revenue SumUpRule(sum_tag='RevenuesSum', potential_summands=detailled_revenue_tags, optional_summands=[ 'OtherSalesRevenueNet' ]), ]), RuleGroup(prefix="Set", description="Rules that might set the Revenue tag." "the order is the precedence.", rules=[ # if Revenues is not set, we use the following precedence: # - SalesRevenueNet # - RevenueFromContractWithCustomerExcludingAssessedTax # - RevenueFromContractWithCustomerIncludingAssessedTax # - RevenuesExcludingInterestAndDividends # - RevenuesSum # - InvestmentIncomeInterest CopyTagRule(original='SalesRevenueNet', target='Revenues'), CopyTagRule( original='RevenueFromContractWithCustomerExcludingAssessedTax', target='Revenues'), CopyTagRule( original='RevenueFromContractWithCustomerIncludingAssessedTax', target='Revenues'), CopyTagRule(original='RevenuesExcludingInterestAndDividends', target='Revenues'), CopyTagRule(original='RevenuesSum', target='Revenues'), CopyTagRule(original='InvestmentIncomeInterest', target='Revenues')]) ] ) is_costofrevenue_rg = RuleGroup( prefix="CostOfRevenues", rules=[ RuleGroup(prefix="Pre", description="Preparation rules which might be usable to estimate " "the cost of revenue", rules=[ SumUpRule(sum_tag='CostOfGoodsSold', potential_summands=[ 'CostOfGoodsSoldExcludingDepreciationDepletionAndAmortization', 'CostOfGoodsSoldDepreciationDepletionAndAmortization', 'CostOfGoodsSoldDepletion', 'CostOfGoodsSoldDepreciation', 'CostOfGoodsSoldAmortization', 'CostOfGoodsSoldDepreciationAndAmortization', 'CostOfGoodsSoldDirectFinancingLease', 'CostOfGoodsSoldElectric', 'CostOfGoodsSoldDirectMaterials', 'CostOfGoodsSoldDirectLabor', 'CostOfGoodsSoldOverhead', 'CostOfGoodsSoldOilAndGas', 'CostOfGoodsSoldSubscription', 'CostOfGoodsSoldDirectTaxesAndLicensesCosts', 'CostOfGoodsSoldMaintenanceCosts', 'CostOfGoodsSoldSalesTypeLease']), SumUpRule(sum_tag='CostOfServices', potential_summands=[ 'CostOfServicesExcludingDepreciationDepletionAndAmortization', 'CostOfServicesDepreciation', 'CostOfServicesDepreciationAndAmortization', 'CostOfServicesCatering', 'CostOfServicesAmortization', 'CostOfServicesOilAndGas', 'CostOfServicesDirectTaxesAndLicensesCosts', 'CostOfServicesMaintenanceCosts', 'CostOfServicesLicensesAndServices', 'CostOfServicesDirectLabor', 'CostOfServicesLicensesAndMaintenanceAgreements', 'CostOfServicesEnergyServices', 'CostOfServicesDirectMaterials', 'CostOfServicesEnvironmentalRemediation', 'CostOfServicesOverhead' ]), SumUpRule(sum_tag='CostOfGoodsAndServicesSold', potential_summands=[ 'CostOfGoodsSold', 'CostOfServices']), SumUpRule(sum_tag='CostOfGoodsAndServicesSold', potential_summands=[ 'CostOfGoodsAndServicesSoldDepreciationAndAmortization', 'CostOfGoodsAndServicesSoldAmortization', 'CostOfGoodsAndServicesSoldOverhead', 'CostOfGoodsAndServicesSoldDepreciation', 'CostOfGoodsAndServicesEnergyCommoditiesAndServices', 'CostOfGoodsAndServiceExcludingDepreciationDepletionAndAmortization'] )]), RuleGroup(prefix="Set", description="Rules that might set the CostOfRevenue tag." "the order is the precedence.", rules=[ CopyTagRule(original='CostOfGoodsAndServicesSold', target='CostOfRevenue')]) ] ) is_missing_rev_cost_gross = RuleGroup( prefix="RevCostGross_missing", description="Calculates the third tag, if two of Revenues, CostOfRevenues, " "and GrossProfit are present", rules=missingsumparts_rules_creator(sum_tag='Revenues', summand_tags=['CostOfRevenue', 'GrossProfit']) ) is_grossprofit_rg = RuleGroup( prefix='GrossProfit', rules=[ RuleGroup(prefix="Set", description="Rules that might set the GrossProfit tag." "The order is the precedence.", rules=[ # for investment companies CopyTagRule(original='GrossInvestmentIncomeOperating', target='GrossProfit'), CopyTagRule(original='InterestAndDividendIncomeOperating', target='GrossProfit')]) ] ) is_missing_gross_opil_opexp = RuleGroup( prefix="GrossOpILOpExp_missing", description="Calculates the third tag, if two of GrossProfit, OperatingExpenses, " "and OperatingIncomeLoss are present", rules=missingsumparts_rules_creator(sum_tag='GrossProfit', summand_tags=['OperatingExpenses', 'OperatingIncomeLoss'])) # this rule has to follow after the previous rule: # first prio is to try to calc OperatingExpenses from GrossProfit-OperatingIncomeLoss # second, we try to calculat OperatingExpenses from the 100 top used operating costs # and then maybe use it in the next iteration to calculate GrossProfit or OpIncLoss # with the previous rule is_operating_expenses_rg = RuleGroup( prefix="OperatingExpenses", rules=[ RuleGroup(prefix="Pre", description="Preparation rules which might be usable to estimate " "OperatingExpenses", rules=[ SumUpRule(sum_tag='OperatingExpensesSum', potential_summands=top_100_operating_costs_tags)]), RuleGroup(prefix="Set", description="Rules that might set the OperatingExpenses tag." "The order is the precedence", rules=[ CopyTagRule(original='OperatingExpensesSum', target='OperatingExpenses')]) ]) is_inclossbeforetax = RuleGroup( prefix="inclossbeforetax", rules=[ RuleGroup(prefix="Pre", description="Preparation rules which might be usable to estimate " "IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit", rules=[ SumUpRule( sum_tag='IncomeLossFromContinuingOperationsFromEquityMethodInvestements', potential_summands=[ 'IncomeLossFromContinuingOperationsBeforeIncomeTaxesMinorityInterestAndIncomeLossFromEquityMethodInvestments', ], optional_summands=['IncomeLossFromEquityMethodInvestments']), ]), RuleGroup(prefix="Set", description="Rules that might set the " "IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit" " tag. The order is the precedence", rules=[ # Renaming CopyTagRule( original='IncomeLossFromContinuingOperationsBeforeIncomeTaxesExtraordinaryItemsNoncontrollingInterest', target='IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit'), CopyTagRule( original='IncomeLossFromContinuingOperationsFromEquityMethodInvestements', target='IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit'), ]) ]) is_netincome_rg = RuleGroup( prefix="netincome", rules=[ RuleGroup(prefix="Pre", description="Preparation rules which might be usable to estimate " "NetIncomeLoss, ProfitLoss, and IncomeLossFromContinuingOperations", rules=[ SumUpRule( sum_tag='AllIncomeTaxExpenseBenefit', potential_summands=[ 'IncomeTaxExpenseBenefit', 'DeferredIncomeTaxExpenseBenefit' ], optional_summands=['IncomeLossFromEquityMethodInvestments']), CopyTagRule( original='IncomeLossFromContinuingOperationsIncludingPortionAttributableToNoncontrollingInterest', target='IncomeLossFromContinuingOperations'), SubtractFromRule( target_tag='IncomeLossFromContinuingOperations', subtract_from_tag='IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit', potential_subtract_tags=['AllIncomeTaxExpenseBenefit'] ), CopyTagRule( original='IncomeLossFromDiscontinuedOperationsNetOfTaxAttributableToReportingEntity', target='IncomeLossFromDiscontinuedOperationsNetOfTax'), SumUpRule(sum_tag='ProfitLossParts', potential_summands=[ 'IncomeLossFromContinuingOperations', 'IncomeLossFromDiscontinuedOperationsNetOfTax' ]) ]), RuleGroup(prefix="SetPL", description="Rules that might set the ProfitLoss tag." "The order is the precedence", rules=[ CopyTagRule(original='ProfitLossParts', target='ProfitLoss'), # if there is no value for ProfitLoss, we set it to NetIncomeLoss CopyTagRule(original='NetIncomeLoss', target='ProfitLoss')]), RuleGroup(prefix="SetILContOp", description="Rules that might set the IncomeLossFromContinuingOperations tag." "The order is the precedence", rules=[ # since IncomeLossFromContinuingOperations is part of a validation rule, # and if it was not set, we assume that there is only # IncomeLossFromContinuingOperations and # copy the value from ProfitLoss CopyTagRule(original='ProfitLoss', target='IncomeLossFromContinuingOperations') ]), # the following rules set the NetIncomeLoss, if not already set. # the order of the rules is the precedence RuleGroup(prefix="SetNIL", description="Rules that might set the NetIncomeLoss tag." "The order is the precedence", rules=[ CopyTagRule(original='NetIncomeLossAvailableToCommonStockholdersBasic', target='NetIncomeLoss'), CopyTagRule(original='NetIncomeLossAllocatedToLimitedPartners', target='NetIncomeLoss'), CopyTagRule(original='ProfitLoss', target='NetIncomeLoss'), CopyTagRule( original='ProfitLossIncludingRedeemableNonControllingInterest', target='NetIncomeLoss'), CopyTagRule(original='OtherComprehensiveIncomeLossNetOfTax', target='NetIncomeLoss'), CopyTagRule(original='ComprehensiveIncomeNetOfTax', target='NetIncomeLoss'), CopyTagRule(original='IncomeLossAttributableToParent', target='NetIncomeLoss'), # for investment companies CopyTagRule(original='NetInvestmentIncome', target='NetIncomeLoss'), ]) ] ) is_missing_ilbefore_tax_ilcontop = RuleGroup( prefix="inclossbefore_tax_inclossop_missing", description="Calculates the third tag, if two of AllIncomeTaxExpenseBenefit," " IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit, " "and IncomeLossFromContinuingOperations are present", rules=missingsumparts_rules_creator( sum_tag='IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit', summand_tags=['IncomeLossFromContinuingOperations', 'AllIncomeTaxExpenseBenefit']) ) is_missing_nilattnoncnt = MissingSummandRule( sum_tag='ProfitLoss', existing_summands_tags=['NetIncomeLoss'], missing_summand_tag='NetIncomeLossAttributableToNoncontrollingInterest' ) is_outstandingshares = RuleGroup( prefix="sharesAndEPS", description="Rules to extract the number of shares", rules=[ CopyTagRule(target='OutstandingShares', original='WeightedAverageNumberOfSharesOutstandingBasic'), CopyTagRule(target='OutstandingShares', original='WeightedAverageNumberOfDilutedSharesOutstanding'), CopyTagRule(target='OutstandingShares', original='WeightedAverageNumberOfShareOutstandingBasicAndDiluted'), CopyTagRule(target='OutstandingShares', original='WeightedAverageLimitedPartnershipUnitsOutstanding'), CopyTagRule(target='OutstandingShares', original='WeightedAverageLimitedPartnershipUnitsOutstandingDiluted'), CopyTagRule(target='OutstandingShares', original='WeightedAverageNumberOfLimitedPartnershipAndGeneralPartnershipUnitOutstandingBasicAndDiluted'), CopyTagRule(target='OutstandingShares', original='WeightedAverageGeneralPartnershipUnitsOutstanding'), CopyTagRule(target='EarningsPerShare', original='EarningsPerShareBasic'), CopyTagRule(target='EarningsPerShare', original='EarningsPerShareDiluted'), CopyTagRule(target='EarningsPerShare', original='EarningsPerShareBasicAndDiluted'), CopyTagRule(target='EarningsPerShare', original='IncomeLossFromContinuingOperationsPerBasicShare'), CopyTagRule(target='EarningsPerShare', original='IncomeLossFromContinuingOperationsPerDilutedShare'), CopyTagRule(target='EarningsPerShare', original='IncomeLossFromContinuingOperationsPerBasicAndDilutedShare'), CopyTagRule(target='EarningsPerShare', original='IncomeLossFromContinuingOperationsPerOutstandingLimitedPartnershipUnit'), CopyTagRule(target='EarningsPerShare', original='IncomeLossFromContinuingOperationsPerOutstandingLimitedPartnershipUnitBasicNetOfTax'), CopyTagRule(target='EarningsPerShare', original='IncomeLossFromContinuingOperationsPerOutstandingLimitedPartnershipAndGeneralPartnershipUnitBasicAndDiluted'), ] ) main_rule_tree = RuleGroup(prefix="IS", rules=[ is_revenue_rg, is_costofrevenue_rg, is_missing_rev_cost_gross, is_grossprofit_rg, is_missing_gross_opil_opexp, is_operating_expenses_rg, is_inclossbeforetax, is_netincome_rg, is_missing_ilbefore_tax_ilcontop, is_missing_nilattnoncnt, is_outstandingshares ]) preprocess_rule_tree = RuleGroup(prefix="IS_PRE", rules=[ ]) post_rule_tree = RuleGroup( prefix="IS", rules=[ PostFixIncomeLossFromContinuingOperationsAndSignOfIncomeTaxExpenseBenefit(), PostFixSign(start_tag='ProfitLoss', summand_tag='AllIncomeTaxExpenseBenefit', result_tag='IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit'), PostFixSign(start_tag='NetIncomeLoss', summand_tag='NetIncomeLossAttributableToNoncontrollingInterest', result_tag='ProfitLoss'), # 1. if there is no value for Revenues, but GrossProfit # we set Revenues to GrossProfit # 2. if there is no value for GrossProfit, but Revenues # we set GrossProfit to Revenues # 3. in both cases, CostOfRevenue is set to zero with the following # MissingSummandRule. CopyTagRule(original='GrossProfit', target='Revenues'), CopyTagRule(original='Revenues', target='GrossProfit'), MissingSummandRule(sum_tag='Revenues', existing_summands_tags=['GrossProfit'], missing_summand_tag='CostOfRevenue'), # Next, we finalize OperatingIncomeLoss, by subtracting # a last time the OperatingExpenses from the GrossProfit, # if OperatingIncomeLoss is not yet set SubtractFromRule(subtract_from_tag='GrossProfit', potential_subtract_tags=['OperatingExpenses'], target_tag='OperatingIncomeLoss'), # 1. if there is no value for IncomeLossFromContinuingOperations, # but for ProfitLoss, we set it to the same value # 2. if there is no value for IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit, # but for IncomeLossFromContinuingOperations, we set it to the same value # 3. afterward, we set IncomeTaxExpenseBenefit to zero with the following rule CopyTagRule(original='ProfitLoss', target='IncomeLossFromContinuingOperations'), CopyTagRule(original='IncomeLossFromContinuingOperations', target='IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit'), MissingSummandRule( sum_tag='IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit', existing_summands_tags=['IncomeLossFromContinuingOperations'], missing_summand_tag='AllIncomeTaxExpenseBenefit'), # if there is no "IncomeLossFromDiscontinuedOperationsNetOfTax", set it to 0 PostSetToZero(tags=['IncomeLossFromDiscontinuedOperationsNetOfTax']), # if IncomeLossFromContinuingOperations is not set, but IL..BeforeIncomeTaxExpenseBenefit is set # set it to IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit CopyTagRule(original='IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit', target='IncomeLossFromContinuingOperations'), # since new IncomeLossFromContinuingOperations values could have been set, # calculate missing ProfitLoss entries, if possible SumUpRule(sum_tag='ProfitLoss', potential_summands=[ 'IncomeLossFromContinuingOperations', 'IncomeLossFromDiscontinuedOperationsNetOfTax' ]), # since new ProfitLoss could have been set, use it to set still missing NetIncomeLoss CopyTagRule(original='ProfitLoss', target='NetIncomeLoss'), # calculate missing NetIncomeLossAttributableToNoncontrollingInterest # which at this point will mean to set it to 0. MissingSummandRule( sum_tag='ProfitLoss', existing_summands_tags=['NetIncomeLoss'], missing_summand_tag='NetIncomeLossAttributableToNoncontrollingInterest'), ]) validation_rules: List[ValidationRule] = [ SumValidationRule(identifier="RevCogGrossCheck", sum_tag='Revenues', summands=['CostOfRevenue', 'GrossProfit']), SumValidationRule(identifier="GrossOpexpOpil", sum_tag='GrossProfit', summands=['OperatingExpenses', 'OperatingIncomeLoss']), SumValidationRule(identifier="ContIncTax", sum_tag='IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit', summands=['AllIncomeTaxExpenseBenefit', 'IncomeLossFromContinuingOperations']), SumValidationRule(identifier='ProfitLoss', sum_tag='ProfitLoss', summands=[ 'IncomeLossFromContinuingOperations', 'IncomeLossFromDiscontinuedOperationsNetOfTax' ]), SumValidationRule(identifier='NetIncomeLoss', sum_tag='ProfitLoss', summands=[ 'NetIncomeLoss', 'NetIncomeLossAttributableToNoncontrollingInterest' ]), ProductValidationRule(identifier='EPS', product_tag='NetIncomeLoss', multipliers=['EarningsPerShare', 'OutstandingShares']), ] # these are the columns that finally are returned after the standardization final_tags: List[str] = ['Revenues', 'CostOfRevenue', 'GrossProfit', 'OperatingExpenses', 'OperatingIncomeLoss', 'IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit', 'AllIncomeTaxExpenseBenefit', 'IncomeLossFromContinuingOperations', 'IncomeLossFromDiscontinuedOperationsNetOfTax', 'ProfitLoss', 'NetIncomeLossAttributableToNoncontrollingInterest', 'NetIncomeLoss', 'OutstandingShares', 'EarningsPerShare' ] # used to evaluate if a report is the main income statement report # inside a report, there can be several tables (different report nr) # which stmt value is IS. # however, we might be only interested in the "major" IS report. Usually this is the # one which has the least nan in the following columns main_statement_tags = ['Revenues', 'SalesRevenueNet', 'SalesRevenueGoodsNet', 'SalesRevenueServicesNet', 'CostOfRevenue', 'CostOfGoodsAndServicesSold', 'CostOfGoodsSold', 'CostOfServices', 'GrossProfit', 'OperatingExpenses', 'OperatingIncomeLoss', 'IncomeLossFromContinuingOperationsBeforeIncomeTaxesMinorityInterestAndIncomeLossFromEquityMethodInvestments', 'IncomeLossFromContinuingOperationsBeforeIncomeTaxesExtraordinaryItemsNoncontrollingInterest', 'IncomeLossBeforeIncomeTaxExpenseBenefit', 'IncomeTaxExpenseBenefit', 'DeferredIncomeTaxExpenseBenefit', 'NetIncomeLoss', 'ProfitLoss' ] def __init__(self, prepivot_rule_tree: Optional[RuleGroup] = None, pre_rule_tree: Optional[RuleGroup] = None, main_rule_tree: Optional[RuleGroup] = None, post_rule_tree: Optional[RuleGroup] = None, validation_rules: Optional[List[ValidationRule]] = None, final_tags: Optional[List[str]] = None, main_statement_tags: Optional[List[str]] = None, filter_for_main_statement: bool = True, main_iterations: int = 3, invert_negated: bool = True, additional_final_sub_fields: Optional[List[str]] = None, additional_final_tags: Optional[List[str]] = None): """ Initialize the Income Statement Standardizer. Fine tune it with the following arguments: Args: prepivot_rule_tree: rules that are applied before the data is pivoted. These are rules that pathfilter (like deduplicate) or correct values. pre_rule_tree: rules that are applied once before the main processing. These are mainly rules that try to correct existing data from obvious errors (like wrong tagging) main_rule_tree: rules that are applied during the main processing rule and which do the heavy lifting. These rules can be executed multiple times depending on the value of the main_iterations parameter post_rule_tree: rules that are used to "cleanup", like setting certain values to 0.0. They are just executed once. validation_rules: Validation rules are applied after all rules were applied. they add validation columns to the main dataset. Validation rules do check if certain requirements are met. E.g. in a Balance Sheet, the following equation should be true: Assets = AssetsCurrent + AssetsNoncurrent final_tags: The list of tags/columns that will appear in the final result dataframe. main_statement_tags: list of tags that is used to identify the main table of a financial statement (income statement, balance sheet, cash flow). filter_for_main_statement (bool): Only consider the reports that contain most of the "main_statement_tags". Default is True. main_iterations (int): Number of times the main rules should be applied. Default is 3 for CashFlow. invert_negated (bool, Optional, True): inverts the value of the tags that are marked as negated (in the pre_df). additional_final_sub_fields (List, Optional): When using the present method, the results are joined with the following fields from the sub_df entry: 'adsh', 'cik', 'form', 'fye', 'fy', 'fp', 'filed' Additional fields can be assigned in this list. Default is None. additional_final_tags (List, Optional): the "final_tags" list define the tags that will be present in the final result dataframe. Additional tags can be added via this parameter. Default is None. """ super().__init__( prepivot_rule_tree= prepivot_rule_tree if prepivot_rule_tree else self.prepivot_rule_tree, pre_rule_tree=pre_rule_tree if pre_rule_tree else self.preprocess_rule_tree, main_rule_tree=main_rule_tree if main_rule_tree else self.main_rule_tree, post_rule_tree=post_rule_tree if post_rule_tree else self.post_rule_tree, validation_rules=validation_rules if validation_rules else self.validation_rules, final_tags=final_tags if final_tags else self.final_tags, main_statement_tags= main_statement_tags if main_statement_tags else self.main_statement_tags, filter_for_main_statement=filter_for_main_statement, main_iterations=main_iterations, invert_negated=invert_negated, additional_final_sub_fields=additional_final_sub_fields, additional_final_tags=additional_final_tags )Ancestors
- Standardizer
- Presenter
- typing.Generic
Class variables
var is_costofrevenue_rgvar is_grossprofit_rgvar is_inclossbeforetaxvar is_missing_gross_opil_opexpvar is_missing_ilbefore_tax_ilcontopvar is_missing_nilattnoncntvar is_missing_rev_cost_grossvar is_netincome_rgvar is_operating_expenses_rgvar is_revenue_rgvar main_rule_treevar post_rule_treevar prepivot_rule_treevar preprocess_rule_treevar validation_rules : List[ValidationRule]
Inherited members
class PostFixIncomeLossFromContinuingOperationsAndSignOfIncomeTaxExpenseBenefit-
Usually, when TaxExpenseBenefit is a positive number, meaning that this amount of taxes were paid by the company. Therefore, the equation
IncomeLossBeforeTaxes - TaxExpenseBenefit = NetIncomeLoss
However, there is a quite significant number of reports, which us a negative number to display paid Taxes and therefore, the following equations would be used:
IncomeLossBeforeTaxes + TaxExpenseBenefit = NetIncomeLoss
This rule select these entries and tries to fix that, whenever possible.
Since the rules calculate IncomeLossFromContinuingOperations as follows
IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit - IncomeTaxExpenseBenefit = IncomeLossFromContinuingOperations
We might end up having a wrong value for IncomeLossFromContinuingOperation.
Therefore, we mask the entries, where
abs(NetIncomeLoss - IncomeLossFromContinuingOperations) = 2*abs(IncomeTaxExpenseBenefit) if IncomeTaxExpenseBenefit > 0
in order to fix the sign for IncomeTaxExpenseBenefit and to correct IncomeLossFromContinuingOperations
The rule also uses some threshold.
Of course, this is not perfect and does not consider the cases with DiscontinuedOperations, However, it is able to fix a significant number of cases.
For the masked entries, it changes the sign of TaxExpenseBenefit and recalculates IncomeLossFromContinuingOperations
Expand source code
class PostFixIncomeLossFromContinuingOperationsAndSignOfIncomeTaxExpenseBenefit(Rule): """ Usually, when TaxExpenseBenefit is a positive number, meaning that this amount of taxes were paid by the company. Therefore, the equation IncomeLossBeforeTaxes - TaxExpenseBenefit = NetIncomeLoss However, there is a quite significant number of reports, which us a negative number to display paid Taxes and therefore, the following equations would be used: IncomeLossBeforeTaxes + TaxExpenseBenefit = NetIncomeLoss This rule select these entries and tries to fix that, whenever possible. Since the rules calculate IncomeLossFromContinuingOperations as follows IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit - IncomeTaxExpenseBenefit = IncomeLossFromContinuingOperations We might end up having a wrong value for IncomeLossFromContinuingOperation. Therefore, we mask the entries, where abs(NetIncomeLoss - IncomeLossFromContinuingOperations) = 2*abs(IncomeTaxExpenseBenefit) if IncomeTaxExpenseBenefit > 0 in order to fix the sign for IncomeTaxExpenseBenefit and to correct IncomeLossFromContinuingOperations The rule also uses some threshold. Of course, this is not perfect and does not consider the cases with DiscontinuedOperations, However, it is able to fix a significant number of cases. For the masked entries, it changes the sign of TaxExpenseBenefit and recalculates IncomeLossFromContinuingOperations """ def get_target_tags(self) -> List[str]: """ returns a list of tags that could be affected/changed by this rule Returns: List[str]: list with affected tags/columns """ return ['IncomeLossFromContinuingOperations', 'AllIncomeTaxExpenseBenefit'] def get_input_tags(self) -> Set[str]: """ return all tags that the rules within this group need. Returns: Set[str]: set of all input tags that are used by rules in this group """ return {'IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit', 'AllIncomeTaxExpenseBenefit', 'IncomeLossFromContinuingOperations', 'ProfitLoss'} def mask(self, data_df: pd.DataFrame) -> pa.typing.Series[bool]: """ returns a Series[bool] which defines the rows to which this rule has to be applied. Args: data_df dataframe on which the rules should be applied Returns: pa.typing.Series[bool]: a boolean Series that marks which rows have to be calculated """ return (data_df.AllIncomeTaxExpenseBenefit != 0) & \ ((data_df.ProfitLoss - data_df.IncomeLossFromContinuingOperations).abs() >= 1.8 * data_df.AllIncomeTaxExpenseBenefit.abs()) def apply(self, data_df: pd.DataFrame, mask: pa.typing.Series[bool]) -> pd.DataFrame: """ apply the rule on the provided dataframe. the rows, on which the rule has to be applied is defined by the provide mask Series. Important, the rules have to be applied "in-place", so no new dataframe is produced. Args: data_df: dataframe on which the rule has to be applied mask: a Series marking the rows in the dataframe on which the rule has to be applied Returns: pd.DataFrame: make the process chainable """ data_df.loc[mask, 'AllIncomeTaxExpenseBenefit'] = -data_df.AllIncomeTaxExpenseBenefit # recalculate IncomeLossFromContinuingOperations data_df.loc[mask, 'IncomeLossFromContinuingOperations'] = \ data_df['IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit'] subtract_mask = mask & ~data_df.AllIncomeTaxExpenseBenefit.isna() data_df.loc[subtract_mask, 'IncomeLossFromContinuingOperations'] = ( data_df['IncomeLossFromContinuingOperations'] - data_df.AllIncomeTaxExpenseBenefit) return data_df def get_description(self) -> str: return "Corrects the sign of 'IncomeTaxExpenseBenefits' if it seems to be wrong. Checks" \ "if the difference between 'NetIncomeLoss' and " \ "'IncomeLossFromContinuingOperations'" \ "is about 2. Which is a clear indication, that the sign was wrong."Ancestors
- Rule
- AbstractRule
- RuleEntity
- abc.ABC
Class variables
var masked : pandas.core.series.Series
Methods
def apply(self, data_df: pandas.core.frame.DataFrame, mask: pandera.typing.pandas.Series[bool]) ‑> pandas.core.frame.DataFrame-
apply the rule on the provided dataframe. the rows, on which the rule has to be applied is defined by the provide mask Series.
Important, the rules have to be applied "in-place", so no new dataframe is produced.
Args
data_df- dataframe on which the rule has to be applied
mask- a Series marking the rows in the dataframe on which the rule has to be applied
Returns
pd.DataFrame- make the process chainable
Expand source code
def apply(self, data_df: pd.DataFrame, mask: pa.typing.Series[bool]) -> pd.DataFrame: """ apply the rule on the provided dataframe. the rows, on which the rule has to be applied is defined by the provide mask Series. Important, the rules have to be applied "in-place", so no new dataframe is produced. Args: data_df: dataframe on which the rule has to be applied mask: a Series marking the rows in the dataframe on which the rule has to be applied Returns: pd.DataFrame: make the process chainable """ data_df.loc[mask, 'AllIncomeTaxExpenseBenefit'] = -data_df.AllIncomeTaxExpenseBenefit # recalculate IncomeLossFromContinuingOperations data_df.loc[mask, 'IncomeLossFromContinuingOperations'] = \ data_df['IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit'] subtract_mask = mask & ~data_df.AllIncomeTaxExpenseBenefit.isna() data_df.loc[subtract_mask, 'IncomeLossFromContinuingOperations'] = ( data_df['IncomeLossFromContinuingOperations'] - data_df.AllIncomeTaxExpenseBenefit) return data_df -
return all tags that the rules within this group need.
Returns
Set[str]- set of all input tags that are used by rules in this group
Expand source code
def get_input_tags(self) -> Set[str]: """ return all tags that the rules within this group need. Returns: Set[str]: set of all input tags that are used by rules in this group """ return {'IncomeLossFromContinuingOperationsBeforeIncomeTaxExpenseBenefit', 'AllIncomeTaxExpenseBenefit', 'IncomeLossFromContinuingOperations', 'ProfitLoss'} def mask(self, data_df: pandas.core.frame.DataFrame) ‑> pandera.typing.pandas.Series[bool]-
returns a Series[bool] which defines the rows to which this rule has to be applied.
Args
data_df dataframe on which the rules should be applied
Returns
pa.typing.Series[bool]- a boolean Series that marks which rows have to be calculated
Expand source code
def mask(self, data_df: pd.DataFrame) -> pa.typing.Series[bool]: """ returns a Series[bool] which defines the rows to which this rule has to be applied. Args: data_df dataframe on which the rules should be applied Returns: pa.typing.Series[bool]: a boolean Series that marks which rows have to be calculated """ return (data_df.AllIncomeTaxExpenseBenefit != 0) & \ ((data_df.ProfitLoss - data_df.IncomeLossFromContinuingOperations).abs() >= 1.8 * data_df.AllIncomeTaxExpenseBenefit.abs())
Inherited members