SBTi.interfaces

Module Contents

Classes

AggregationContribution

Aggregation

ScoreAggregation

ScoreAggregationScopes

ScoreAggregations

ScenarioInterface

PortfolioCompany

IDataProviderCompany

SortableEnum

Generic enumeration.

EScope

Generic enumeration.

ETimeFrames

Generic enumeration.

IDataProviderTarget

class SBTi.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 SBTi.interfaces.Aggregation

Bases: pydantic.BaseModel

score :float
proportion :float
contributions :List[AggregationContribution]
__getitem__(self, item)
class SBTi.interfaces.ScoreAggregation

Bases: pydantic.BaseModel

all :Aggregation
influence_percentage :float
grouped :Dict[str, Aggregation]
__getitem__(self, item)
class SBTi.interfaces.ScoreAggregationScopes

Bases: pydantic.BaseModel

S1S2 :Optional[ScoreAggregation]
S3 :Optional[ScoreAggregation]
S1S2S3 :Optional[ScoreAggregation]
__getitem__(self, item)
class SBTi.interfaces.ScoreAggregations

Bases: pydantic.BaseModel

short :Optional[ScoreAggregationScopes]
mid :Optional[ScoreAggregationScopes]
long :Optional[ScoreAggregationScopes]
__getitem__(self, item)
class SBTi.interfaces.ScenarioInterface

Bases: pydantic.BaseModel

number :int
engagement_type :Optional[str]
class SBTi.interfaces.PortfolioCompany

Bases: pydantic.BaseModel

company_name :str
company_id :str
company_isin :Optional[str]
investment_value :float
engagement_target :Optional[bool] = False
user_fields :Optional[dict]
class SBTi.interfaces.IDataProviderCompany

Bases: pydantic.BaseModel

company_name :str
company_id :str
isic :str
ghg_s1s2 :float
ghg_s3 :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]
company_market_cap :Optional[float]
company_enterprise_value :Optional[float]
company_total_assets :Optional[float]
company_cash_equivalents :Optional[float]
sbti_validated :bool
class SBTi.interfaces.SortableEnum

Bases: enum.Enum

Generic 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 SBTi.interfaces.EScope

Bases: SBTi.interfaces.SortableEnum

Generic enumeration.

Derive from this class to define new enumerations.

S1 = S1
S2 = S2
S3 = S3
S1S2 = S1+S2
S1S2S3 = S1+S2+S3
classmethod get_result_scopes(cls) → List[‘EScope’]

Get a list of scopes that should be calculated if the user leaves it open.

Returns

A list of EScope objects

class SBTi.interfaces.ETimeFrames

Bases: SBTi.interfaces.SortableEnum

Generic enumeration.

Derive from this class to define new enumerations.

SHORT = short
MID = mid
LONG = long
class SBTi.interfaces.IDataProviderTarget

Bases: pydantic.BaseModel

company_id :str
target_type :str
intensity_metric :Optional[str]
scope :EScope
coverage_s1 :float
coverage_s2 :float
coverage_s3 :float
reduction_ambition :float
base_year :int
base_year_ghg_s1 :float
base_year_ghg_s2 :float
base_year_ghg_s3 :float
start_year :Optional[int]
end_year :int
time_frame :Optional[ETimeFrames]
achieved_reduction :Optional[float] = 0
validate_e(cls, val)