ITR.interfaces
Module Contents
Classes
Generic enumeration. |
|
Generic enumeration. |
|
Generic enumeration. |
|
Generic enumeration. |
|
Generic enumeration. |
|
- class ITR.interfaces.AggregationContribution
Bases:
pydantic.BaseModel- company_name :str
- company_id :str
- temperature_score :float
- contribution_relative :Optional[float]
- contribution :Optional[float]
- __getitem__(self, item)
- class ITR.interfaces.Aggregation
Bases:
pydantic.BaseModel- score :float
- proportion :float
- contributions :List[AggregationContribution]
- __getitem__(self, item)
- class ITR.interfaces.ScoreAggregation
Bases:
pydantic.BaseModel- all :Aggregation
- influence_percentage :float
- grouped :Dict[str, Aggregation]
- __getitem__(self, item)
- class ITR.interfaces.ScoreAggregationScopes
Bases:
pydantic.BaseModel- S1 :Optional[ScoreAggregation]
- S2 :Optional[ScoreAggregation]
- S1S2 :Optional[ScoreAggregation]
- S3 :Optional[ScoreAggregation]
- S1S2S3 :Optional[ScoreAggregation]
- __getitem__(self, item)
- class ITR.interfaces.ScoreAggregations
Bases:
pydantic.BaseModel- short :Optional[ScoreAggregationScopes]
- mid :Optional[ScoreAggregationScopes]
- long :Optional[ScoreAggregationScopes]
- __getitem__(self, item)
- class ITR.interfaces.ScenarioInterface
Bases:
pydantic.BaseModel- number :int
- engagement_type :Optional[str]
- class ITR.interfaces.PortfolioCompany
Bases:
pydantic.BaseModel- company_name :str
- company_id :str
- company_isin :Optional[str]
- company_lei :Optional[str]
- investment_value :float
- engagement_target :Optional[bool] = False
- user_fields :Optional[dict]
- class ITR.interfaces.IDataProviderCompany
Bases:
pydantic.BaseModel- company_name :str
- company_id :str
- isic :str
- ghg_s1 :Optional[float]
- ghg_s2 :Optional[float]
- ghg_s1s2 :Optional[float]
- ghg_s3 :Optional[float]
- ghg_s3_1 :Optional[float]
- ghg_s3_2 :Optional[float]
- ghg_s3_3 :Optional[float]
- ghg_s3_4 :Optional[float]
- ghg_s3_5 :Optional[float]
- ghg_s3_6 :Optional[float]
- ghg_s3_7 :Optional[float]
- ghg_s3_8 :Optional[float]
- ghg_s3_9 :Optional[float]
- ghg_s3_10 :Optional[float]
- ghg_s3_11 :Optional[float]
- ghg_s3_12 :Optional[float]
- ghg_s3_13 :Optional[float]
- ghg_s3_14 :Optional[float]
- ghg_s3_15 :Optional[float]
- country :Optional[str]
- region :Optional[str]
- sector :Optional[str]
- industry_level_1 :Optional[str]
- industry_level_2 :Optional[str]
- industry_level_3 :Optional[str]
- industry_level_4 :Optional[str]
- company_revenue :Optional[float] = 0.0
- company_market_cap :Optional[float] = 0.0
- company_enterprise_value :Optional[float] = 0.0
- company_total_assets :Optional[float] = 0.0
- company_cash_equivalents :Optional[float] = 0.0
- sbti_validated :bool
- class ITR.interfaces.SortableEnum
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- __str__(self)
Return str(self).
- __ge__(self, other)
Return self>=value.
- __gt__(self, other)
Return self>value.
- __le__(self, other)
Return self<=value.
- __lt__(self, other)
Return self<value.
- class ITR.interfaces.EScope
Bases:
SortableEnumGeneric enumeration.
Derive from this class to define new enumerations.
- S1 = S1
- S2 = S2
- S1S2 = S1+S2
- S3 = S3
- S1S2S3 = S1+S2+S3
- class ITR.interfaces.ETimeFrames
Bases:
SortableEnumGeneric enumeration.
Derive from this class to define new enumerations.
- SHORT = short
- MID = mid
- LONG = long
- class ITR.interfaces.ETargetReference
Bases:
SortableEnumGeneric enumeration.
Derive from this class to define new enumerations.
- ABSOLUTE = absolute
- INT_TO_ABS = int_to_abs
- INTENSITY = intensity
- T_SCORE = t_score
- class ITR.interfaces.S3Category
Bases:
SortableEnumGeneric enumeration.
Derive from this class to define new enumerations.
- CAT_1 = 1
- CAT_2 = 2
- CAT_3 = 3
- CAT_4 = 4
- CAT_5 = 5
- CAT_6 = 6
- CAT_7 = 7
- CAT_8 = 8
- CAT_9 = 9
- CAT_10 = 10
- CAT_11 = 11
- CAT_12 = 12
- CAT_13 = 13
- CAT_14 = 14
- CAT_15 = 15
- CAT_H_LINE = 0
- N_A
- class ITR.interfaces.IDataProviderTarget
Bases:
pydantic.BaseModel- company_id :str
- target_type :str
- intensity_metric :Optional[str]
- base_year_ts :Optional[float]
- end_year_ts :Optional[float]
- scope :EScope
- s3_category :Optional[S3Category]
- coverage_s1 :Optional[float]
- coverage_s2 :Optional[float]
- coverage_s3 :Optional[float]
- reduction_ambition :Optional[float]
- base_year :int
- base_year_ghg_s1 :Optional[float]
- base_year_ghg_s2 :Optional[float]
- base_year_ghg_s1s2 :Optional[float]
- base_year_ghg_s3 :Optional[float]
- start_year :Optional[int]
- end_year :int
- statement_date :Optional[datetime.date]
- time_frame :Optional[ETimeFrames]
- achieved_reduction :Optional[float] = 0.0
- to_calculate :Optional[bool] = False
- target_ids :List[str]
- classmethod pre(cls, values)
- validate_e(cls, val)
- convert_to_list(cls, v)
targets can be combined so target_ids field must be a list pre=True is used to ensure that the validator is called before the default_factory with pre=True and default_factory the users can supply single strings, e.g. “Target1”
- equals(self, other: IDataProviderTarget) bool
Check if two targets are equal. :param other: The other target :return: True if the targets are equal, False otherwise