API reference¶
See also the Implementation notes.
Top-level methods and classes¶
-
class
sdmx.
Request
(source=None, log_level=None, **session_opts)[source]¶ Client for a SDMX REST web service.
- Parameters
source (str or source.Source) – Identifier of a data source. If a string, must be one of the known sources in
list_sources()
.log_level (int) – Override the package-wide logger with one of the standard logging levels.
**session_opts – Additional keyword arguments are passed to
Session
.
-
get
(resource_type=None, resource_id=None, tofile=None, use_cache=False, dry_run=False, **kwargs)[source]¶ Retrieve SDMX data or metadata.
(Meta)data is retrieved from the
source
of the current Request. The item(s) to retrieve can be specified in one of two ways:resource_type, resource_id: These give the type (see
Resource
) and, optionally, ID of the item(s). If the resource_id is not given, all items of the given type are retrieved.a resource object, i.e. a
MaintainableArtefact
: resource_type and resource_id are determined by the object’s class andid
attribute, respectively.
Data is retrieved with resource_type=’data’. In this case, the optional keyword argument key can be used to constrain the data that is retrieved. Examples of the formats for key:
{'GEO': ['EL', 'ES', 'IE']}
:dict
with dimension name(s) mapped to an iterable of allowable values.{'GEO': 'EL+ES+IE'}
:dict
with dimension name(s) mapped to strings joining allowable values with ‘+’, the logical ‘or’ operator for SDMX web services.'....EL+ES+IE'
:str
in which ordered dimension values (some empty,''
) are joined with'.'
. Using this form requires knowledge of the dimension order in the target data resource_id; in the example, dimension ‘GEO’ is the fifth of five dimensions:'.'.join(['', '', '', '', 'EL+ES+IE'])
.CubeRegion.to_query_string()
can also be used to create properly formatted strings.
For formats 1 and 2, but not 3, the key argument is validated against the relevant
DataStructureDefinition
, either given with the dsd keyword argument, or retrieved from the web service before the main query.For the optional param keyword argument, some useful parameters are:
‘startperiod’, ‘endperiod’: restrict the time range of data to retrieve.
‘references’: control which item(s) related to a metadata resource are retrieved, e.g. references=’parentsandsiblings’.
- Parameters
resource_type (str or
Resource
, optional) – Type of resource to retrieve.resource_id (str, optional) – ID of the resource to retrieve.
tofile (str or
PathLike
or file-like object, optional) – File path or file-like to write SDMX data as it is recieved.use_cache (bool, optional) – If
True
, return a previously retrievedMessage
fromcache
, or update the cache with a newly-retrieved Message.dry_run (bool, optional) – If
True
, prepare and return arequests.Request
object, but do not execute the query. The prepared URL and headers can be examined by inspecting the returned object.**kwargs – Other, optional parameters (below).
- Other Parameters
dsd (
DataStructureDefinition
) – Existing object used to validate the key argument. If not provided, an additional query executed to retrieve a DSD in order to validate the key.force (bool) – If
True
, execute the query even if thesource
does not support queries for the given resource_type. Default:False
.headers (dict) – HTTP headers. Given headers will overwrite instance-wide headers passed to the constructor. Default:
None
to use the default headers of thesource
.key (str or dict) – For queries with resource_type=’data’.
str
values are not validated;dict
values are validated usingmake_constraint()
.params (dict) – Query parameters. The SDMX REST web service guidelines describe parameters and allowable values for different queries. params is not validated before the query is executed.
provider (str) – ID of the agency providing the data or metadata. Default: ID of the
source
agency.An SDMX web service is a ‘data source’ operated by a specific, ‘source’ agency. A web service may host data or metadata originally published by one or more ‘provider’ agencies. Many sources are also providers. Other agencies—e.g. the SDMX Global Registry—simply aggregate (meta)data from other providers, but do not providing any (meta)data themselves.
resource (
MaintainableArtefact
subclass) – Object to retrieve. If given, resource_type and resource_id are ignored.version (str) –
version>
of a resource to retrieve. Default: the keyword ‘latest’.
- Returns
The requested SDMX message or, if dry_run is
True
, the prepared request object.- Return type
- Raises
NotImplementedError – If the
source
does not support the given resource_type and force is notTrue
.
-
preview_data
(flow_id, key={})[source]¶ Return a preview of data.
For the Dataflow flow_id, return all series keys matching key. preview_data() uses a feature supported by some data providers that returns
SeriesKeys
without the correspondingObservations
.To count the number of series:
keys = sdmx.Request('PROVIDER').preview_data('flow') len(keys)
To get a
pandas
object containing the key values:keys_df = sdmx.to_pandas(keys)
- Parameters
- Returns
- Return type
list of
SeriesKey
-
source
= None¶ source.Source
for requests sent from the instance.
-
class
sdmx.
Resource
[source]¶ Enumeration of SDMX REST API endpoints.
Enum
membersdmx.model
classcategoryscheme
codelist
conceptscheme
data
dataflow
datastructure
provisionagreement
-
sdmx.
add_source
(info, id=None, override=False, **kwargs)[source]¶ Add a new data source.
The info expected is in JSON format:
{ "id": "ESTAT", "documentation": "http://data.un.org/Host.aspx?Content=API", "url": "http://ec.europa.eu/eurostat/SDMX/diss-web/rest", "name": "Eurostat", "supported": {"codelist": false, "preview": true} }
…with unspecified values using the defaults; see
Source
.- Parameters
info (dict-like) – String containing JSON information about a data source.
id (str) – Identifier for the new datasource. If
None
(default), then info[‘id’] is used.override (bool) – If
True
, replace any existing data source with id. Otherwise, raiseValueError
.**kwargs – Optional callbacks for handle_response and finish_message hooks.
-
sdmx.
list_sources
()[source]¶ Return a sorted list of valid source IDs.
These can be used to create
Request
instances.
-
sdmx.
read_sdmx
(filename_or_obj, format=None, **kwargs)[source]¶ Load a SDMX-ML or SDMX-JSON message from a file or file-like object.
- Parameters
filename_or_obj (str or
PathLike
or file) –format ('XML' or 'JSON', optional) –
- Other Parameters
dsd (
DataStructureDefinition
) – For “structure-specific” format`=``XML` messages only.
-
sdmx.
to_pandas
(obj, *args, **kwargs)[source]¶ Convert an SDMX obj to
pandas
object(s).See sdmx.writer.pandas.
-
sdmx.
to_xml
(obj, **kwargs)[source]¶ Convert an SDMX obj to SDMX-ML.
- Parameters
kwargs – Passed to
lxml.etree.to_string()
, e.g. pretty_print =True
.- Raises
NotImplementedError – If writing specific objects to SDMX-ML has not been implemented in
sdmx
.
-
sdmx.
logger
= <Logger sdmx (ERROR)>¶ Top-level logger. By default, messages at the log level
ERROR
or greater are printed tosys.stderr
. These include the web service query details (URL and headers) used byRequest
.To debug requets to web services, set to a more permissive level:
import logging sdmx.logger.setLevel(logging.DEBUG)
New in version 0.4.
message
: SDMX messages¶
Classes for SDMX messages.
Message
and related classes are not defined in the SDMX
information model, but in the
SDMX-ML standard.
sdmx
also uses DataMessage
to encapsulate SDMX-JSON data
returned by data sources.
-
class
sdmx.message.
DataMessage
[source]¶ Bases:
sdmx.message.Message
Data Message.
Note
A DataMessage may contain zero or more
DataSet
, sodata
is a list. To retrieve the first (and possibly only) data set in the message, access the first element of the list:msg.data[0]
.-
dataflow
: model.DataflowDefinition = None¶ DataflowDefinition
that contains the data.
-
observation_dimension
: Optional[Union[model._AllDimensions, model.DimensionComponent, List[model.DimensionComponent]]] = None¶ The “dimension at observation level”.
-
-
class
sdmx.message.
ErrorMessage
[source]¶ Bases:
sdmx.message.Message
-
header
= None¶
-
response
= None¶
-
Bases:
sdmx.util.BaseModel
Footer of an SDMX-ML message.
SDMX-JSON messages do not have footers.
The body text of the Footer contains zero or more blocks of text.
-
class
sdmx.message.
Header
[source]¶ Bases:
sdmx.util.BaseModel
Header of an SDMX-ML message.
SDMX-JSON messages do not have headers.
-
error
: Optional[Text] = None¶ (optional) Error code for the message.
-
id
: Optional[Text] = None¶ Identifier for the message.
-
prepared
: Optional[Text] = None¶ Date and time at which the message was generated.
-
receiver
: Optional[model.Agency] = None¶ Intended recipient of the message, e.g. the user’s name for an authenticated service.
-
source
: model.InternationalString = None¶
-
test
: bool = None¶
-
-
class
sdmx.message.
Message
[source]¶ Bases:
sdmx.util.BaseModel
(optional)
Footer
instance.
-
response
: Optional[Response] = None¶ requests.Response
instance for the response to the HTTP request that returned the Message. This is not part of the SDMX standard.
-
class
sdmx.message.
StructureMessage
[source]¶ Bases:
sdmx.message.Message
-
category_scheme
: DictLike[str, model.CategoryScheme] = None¶ Collection of
CategoryScheme
.
-
concept_scheme
: DictLike[str, model.ConceptScheme] = None¶ Collection of
ConceptScheme
.
-
constraint
: DictLike[str, model.ContentConstraint] = None¶ Collection of
ContentConstraint
.
-
dataflow
: DictLike[str, model.DataflowDefinition] = None¶ Collection of
DataflowDefinition
.
-
organisation_scheme
: DictLike[str, model.AgencyScheme] = None¶ Collection of
AgencyScheme
.
-
provisionagreement
: DictLike[str, model.ProvisionAgreement] = None¶ Collection of
ProvisionAgreement
.
-
structure
: DictLike[str, model.DataStructureDefinition] = None¶ Collection of
DataStructureDefinition
.
-
model
: SDMX Information Model¶
SDMX Information Model (SDMX-IM).
This module implements many of the classes described in the SDMX-IM specification (‘spec’), which is available from:
- https://sdmx.org/wp-content/uploads/
SDMX_2-1-1_SECTION_2_InformationModel_201108.pdf
Details of the implementation:
Python typing and pydantic are used to enforce the types of attributes that reference instances of other classes.
Some classes have convenience attributes not mentioned in the spec, to ease navigation between related objects. These are marked “
pandaSDMX
extension not in the IM.”Class definitions are grouped by section of the spec, but these sections appear out of order so that dependent classes are defined first.
-
class
sdmx.model.
ActionType
¶ Bases:
enum.Enum
An enumeration.
-
append
= 3¶
-
delete
= 1¶
-
information
= 4¶
-
replace
= 2¶
-
-
class
sdmx.model.
Agency
(*args, **kwargs)[source]¶ Bases:
sdmx.model.Organisation
-
contact
= None¶
-
-
class
sdmx.model.
AgencyScheme
(**kwargs)[source]¶ Bases:
sdmx.model.ItemScheme
,sdmx.model.OrganisationScheme
-
is_partial
= None¶
-
items
= None¶
-
-
class
sdmx.model.
AnnotableArtefact
[source]¶ Bases:
sdmx.util.BaseModel
-
annotations
: List[Annotation] = None¶ Annotations
of the object.pandaSDMX
implementation: The IM does not specify the name of this feature.
-
-
class
sdmx.model.
Annotation
[source]¶ Bases:
sdmx.util.BaseModel
-
id
: Optional[str] = None¶ Can be used to disambiguate multiple annotations for one AnnotableArtefact.
-
text
: InternationalString = None¶ Content of the annotation.
-
title
: Optional[str] = None¶ Title, used to identify an annotation.
-
type
: Optional[str] = None¶ Specifies how the annotation is processed.
-
url
: Optional[str] = None¶ A link to external descriptive text.
-
-
class
sdmx.model.
AttachmentConstraint
(**kwargs)[source]¶ Bases:
sdmx.model.Constraint
-
attachment
: Set[ConstrainableArtefact] = None¶
-
-
class
sdmx.model.
AttributeDescriptor
(*args, **kwargs)[source]¶ Bases:
sdmx.model.ComponentList
-
components
= None¶
-
-
class
sdmx.model.
AttributeRelationship
[source]¶ Bases:
sdmx.util.BaseModel
-
class
sdmx.model.
AttributeValue
(*args, **kwargs)[source]¶ Bases:
sdmx.util.BaseModel
SDMX-IM AttributeValue.
In the spec, AttributeValue is an abstract class. Here, it serves as both the concrete subclasses CodedAttributeValue and UncodedAttributeValue.
-
start_date
: Optional[date] = None¶
-
value
: Union[str, Code] = None¶
-
value_for
: Optional[DataAttribute] = None¶
-
-
class
sdmx.model.
Categorisation
(**kwargs)[source]¶ Bases:
sdmx.model.MaintainableArtefact
-
artefact
: Optional[IdentifiableArtefact] = None¶
-
category
: Optional[Category] = None¶
-
-
class
sdmx.model.
Category
(*args, **kwargs)[source]¶ Bases:
sdmx.model.Item
SDMX-IM Category.
-
child
= None¶
-
parent
= None¶
-
-
class
sdmx.model.
CategoryScheme
(**kwargs)[source]¶ Bases:
sdmx.model.ItemScheme
-
is_partial
= None¶
-
items
= None¶
-
-
class
sdmx.model.
Code
(*args, **kwargs)[source]¶ Bases:
sdmx.model.Item
SDMX-IM Code.
-
child
= None¶
-
parent
= None¶
-
-
class
sdmx.model.
Codelist
(**kwargs)[source]¶ Bases:
sdmx.model.ItemScheme
-
is_partial
= None¶
-
items
= None¶
-
-
class
sdmx.model.
Component
(*args, **kwargs)[source]¶ Bases:
sdmx.model.IdentifiableArtefact
-
concept_identity
: Optional[Concept] = None¶
-
local_representation
: Optional[Representation] = None¶
-
-
class
sdmx.model.
ComponentList
(*args, **kwargs)[source]¶ Bases:
sdmx.model.IdentifiableArtefact
,typing.Generic
-
append
(value: CT)[source]¶ Append value to
components
.
-
auto_order
= None¶
-
components
: List[CT] = None¶
-
getdefault
(id, cls=None, **kwargs) → CT[source]¶ Return or create the component with the given id.
If the component is automatically created, its
Dimension.order
attribute is set to the value ofauto_order
, which is then incremented.- Parameters
id (str) – Component ID.
cls (type, optional) – Hint for the class of a new object.
kwargs – Passed to the constructor of
Component
, or a Component subclass ifcomponents
is overridden in a subclass of ComponentList.
-
-
class
sdmx.model.
ComponentValue
[source]¶ Bases:
sdmx.util.BaseModel
-
value
: str = None¶
-
value_for
: Component = None¶
-
-
class
sdmx.model.
Concept
(*args, **kwargs)[source]¶ Bases:
sdmx.model.Item
-
core_representation
: Optional[Representation] = None¶
-
iso_concept
: Optional[ISOConceptReference] = None¶
-
-
class
sdmx.model.
ConceptScheme
(**kwargs)[source]¶ Bases:
sdmx.model.ItemScheme
-
is_partial
= None¶
-
items
= None¶
-
-
class
sdmx.model.
ConstrainableArtefact
[source]¶ Bases:
sdmx.util.BaseModel
SDMX-IM ConstrainableArtefact.
-
class
sdmx.model.
Constraint
(**kwargs)[source]¶ Bases:
sdmx.model.MaintainableArtefact
-
data_content_keys
: Optional[DataKeySet] = None¶ DataKeySet
included in the Constraint.
-
role
: ConstraintRole = None¶
-
-
class
sdmx.model.
ConstraintRole
[source]¶ Bases:
sdmx.util.BaseModel
-
role
: ConstraintRoleType = None¶
-
-
class
sdmx.model.
Contact
[source]¶ Bases:
sdmx.util.BaseModel
Organization contact information.
IMF is the only data provider that returns messages with
Contact
information. These differ from the IM in several ways. This class reflects these differences:‘name’ and ‘org_unit’ are InternationalString, instead of strings.
‘email’ may be a list of e-mail addresses, rather than a single address.
‘uri’ may be a list of URIs, rather than a single URI.
-
email
: List[str] = None¶
-
name
: InternationalString = None¶
-
org_unit
: InternationalString = None¶
-
responsibility
: InternationalString = None¶
-
telephone
: Optional[str] = None¶
-
uri
: List[str] = None¶
-
class
sdmx.model.
ContentConstraint
(**kwargs)[source]¶ Bases:
sdmx.model.Constraint
-
content
: Set[ConstrainableArtefact] = None¶
-
data_content_region
: List[CubeRegion] = None¶ CubeRegions
included in the ContentConstraint.
-
-
class
sdmx.model.
CubeRegion
[source]¶ Bases:
sdmx.util.BaseModel
-
included
: bool = None¶
-
member
: Dict['Dimension', MemberSelection] = None¶
-
-
class
sdmx.model.
DataAttribute
(*args, **kwargs)[source]¶ Bases:
sdmx.model.Component
-
usage_status
: Optional[UsageStatus] = None¶
-
-
class
sdmx.model.
DataKey
[source]¶ Bases:
sdmx.util.BaseModel
-
included
: bool = None¶ True
if thekeys
are included in theConstraint
;False
if they are excluded.
-
key_value
: Dict[Component, ComponentValue] = None¶ Mapping from
Component
toComponentValue
comprising the key.
-
-
class
sdmx.model.
DataKeySet
[source]¶ Bases:
sdmx.util.BaseModel
-
included
: bool = None¶ True
if thekeys
are included in theConstraint
;False
if they are excluded.
-
-
class
sdmx.model.
DataProvider
(*args, **kwargs)[source]¶ Bases:
sdmx.model.Organisation
,sdmx.model.ConstrainableArtefact
SDMX-IM DataProvider.
-
contact
= None¶
-
-
class
sdmx.model.
DataProviderScheme
(**kwargs)[source]¶ Bases:
sdmx.model.ItemScheme
,sdmx.model.OrganisationScheme
-
is_partial
= None¶
-
items
= None¶
-
-
class
sdmx.model.
DataSet
[source]¶ Bases:
sdmx.model.AnnotableArtefact
-
action
: Optional[ActionType] = None¶
-
add_obs
(observations, series_key=None)[source]¶ Add observations to a series with series_key.
Checks consistency and adds group associations.
-
attrib
: DictLike[str, AttributeValue] = None¶
-
group
: DictLike[GroupKey, List[Observation]] = None¶ Map of group key → list of observations.
sdmx
extension not in the IM.
-
obs
: List[Observation] = None¶ All observations in the DataSet.
-
series
: DictLike[SeriesKey, List[Observation]] = None¶ Map of series key → list of observations.
sdmx
extension not in the IM.
-
structured_by
: Optional[DataStructureDefinition] = None¶
-
valid_from
: Optional[str] = None¶
-
-
class
sdmx.model.
DataStructureDefinition
(**kwargs)[source]¶ Bases:
sdmx.model.Structure
,sdmx.model.ConstrainableArtefact
SDMX-IM DataStructureDefinition (‘DSD’).
-
attributes
: AttributeDescriptor = None¶ A
AttributeDescriptor
that describes the attributes of the data structure.
-
dimensions
: DimensionDescriptor = None¶ A
DimensionDescriptor
that describes the dimensions of the data structure.
-
classmethod
from_keys
(keys)[source]¶ Return a new DSD given some keys.
The DSD’s
dimensions
refers to a set of newConcepts
andCodelists
, created to represent all the values observed across keys for each dimension.
-
group_dimensions
: DictLike[str, GroupDimensionDescriptor] = None¶ Mapping from
GroupDimensionDescriptor.id
toGroupDimensionDescriptor
.
-
make_constraint
(key)[source]¶ Return a constraint for key.
key is a
dict
wherein:keys are
str
ids of Dimensions appearing in this DSD’sdimensions
, andvalues are ‘+’-delimited
str
containing allowable values, _or_ iterables ofstr
, each an allowable value.
For example:
cc2 = dsd.make_constraint({'foo': 'bar+baz', 'qux': 'q1+q2+q3'})
cc2
includes any key where the ‘foo’ dimension is ‘bar’ or ‘baz’, and the ‘qux’ dimension is one of ‘q1’, ‘q2’, or ‘q3’.- Returns
A constraint with one
CubeRegion
in itsdata_content_region
, including only the values appearing in keys.- Return type
- Raises
ValueError – if key contains a dimension IDs not appearing in
dimensions
.
-
make_key
(key_cls, values: Mapping, extend=False, group_id=None)[source]¶ Make a
Key
or subclass.- Parameters
key_cls (Key or SeriesKey or GroupKey) – Class of Key to create.
values (dict) – Used to construct
Key.values
.extend (bool, optional) – If
True
, make_key will not returnKeyError
on mission dimensions. Insteaddimensions
(key_cls is Key or SeriesKey) orgroup_dimensions
(key_cls is GroupKey) will be extended by creating new Dimension objects.group_id (str, optional) – When key_cls is :class`.GroupKey`, the ID of the
GroupDimensionDescriptor
that structures the key.
- Returns
An instance of key_cls.
- Return type
- Raises
KeyError – If any of the keys of values is not a Dimension or Attribute in the DSD.
-
measures
: MeasureDescriptor = None¶
-
-
class
sdmx.model.
DataflowDefinition
(**kwargs)[source]¶ Bases:
sdmx.model.StructureUsage
,sdmx.model.ConstrainableArtefact
-
structure
: DataStructureDefinition = None¶
-
-
class
sdmx.model.
Datasource
[source]¶ Bases:
sdmx.util.BaseModel
-
url
: str = None¶
-
-
class
sdmx.model.
Dimension
(*args, **kwargs)[source]¶ Bases:
sdmx.model.DimensionComponent
SDMX-IM Dimension.
-
order
= None¶
-
-
class
sdmx.model.
DimensionComponent
(*args, **kwargs)[source]¶ Bases:
sdmx.model.Component
-
order
: Optional[int] = None¶
-
-
class
sdmx.model.
DimensionDescriptor
(*args, **kwargs)[source]¶ Bases:
sdmx.model.ComponentList
Describes a set of dimensions.
IM: “An ordered set of metadata concepts that, combined, classify a statistical series, and whose values, when combined (the key) in an instance such as a data set, uniquely identify a specific observation.”
components
is alist
(ordered) ofDimension
,MeasureDimension
, and/orTimeDimension
.-
assign_order
()[source]¶ Assign the
DimensionComponent.order
attribute.The Dimensions in
components
are numbered, starting from 1.
-
components
= None¶
-
-
class
sdmx.model.
DimensionRelationship
[source]¶ Bases:
sdmx.model.AttributeRelationship
-
dimensions
: List[DimensionComponent] = None¶
-
group_key
: Optional['GroupDimensionDescriptor'] = None¶ NB the IM says “0..*” here in a diagram, but the text does not match.
-
-
class
sdmx.model.
Facet
[source]¶ Bases:
sdmx.util.BaseModel
-
type
: FacetType = None¶
-
value
: Optional[str] = None¶
-
value_type
: Optional[FacetValueType] = None¶
-
-
class
sdmx.model.
FacetType
[source]¶ Bases:
sdmx.util.BaseModel
-
decimals
: Optional[int] = None¶
-
end_time
: Optional[datetime] = None¶
-
end_value
: Optional[str] = None¶
-
interval
: Optional[float] = None¶
-
is_sequence
: Optional[bool] = None¶
-
max_length
: Optional[int] = None¶
-
max_value
: Optional[float] = None¶
-
min_length
: Optional[int] = None¶
-
min_value
: Optional[float] = None¶
-
pattern
: Optional[str] = None¶
-
start_time
: Optional[datetime] = None¶
-
start_value
: Optional[float] = None¶
-
time_interval
: Optional[timedelta] = None¶
-
-
class
sdmx.model.
FacetValueType
¶ Bases:
enum.Enum
An enumeration.
-
alpha
= 13¶
-
alphaNumeric
= 14¶
-
basicTimePeriod
= 20¶
-
bigInteger
= 2¶
-
boolean
= 9¶
-
count
= 11¶
-
dataSetReference
= 43¶
-
dateTime
= 34¶
-
day
= 38¶
-
decimal
= 6¶
-
double
= 8¶
-
duration
= 40¶
-
exclusiveValueRange
= 16¶
-
float
= 7¶
-
gregorianDay
= 25¶
-
gregorianMonth
= 23¶
-
gregorianTimePeriod
= 21¶
-
gregorianYear
= 22¶
-
gregorianYearMonth
= 24¶
-
identifiableReference
= 42¶
-
inclusiveValueRange
= 12¶
-
incremental
= 17¶
-
integer
= 3¶
-
keyValues
= 41¶
-
long
= 4¶
-
month
= 36¶
-
monthDay
= 37¶
-
numeric
= 15¶
-
observationalTimePeriod
= 18¶
-
reportingDay
= 33¶
-
reportingMonth
= 31¶
-
reportingQuarter
= 30¶
-
reportingSemester
= 28¶
-
reportingTimePeriod
= 26¶
-
reportingTrimester
= 29¶
-
reportingWeek
= 32¶
-
reportingYear
= 27¶
-
short
= 5¶
-
standardTimePeriod
= 19¶
-
string
= 1¶
-
time
= 39¶
-
timesRange
= 35¶
-
uri
= 10¶
-
-
class
sdmx.model.
GenericDataSet
[source]¶ Bases:
sdmx.model.DataSet
SDMX-IM GenericDataSet.
-
action
= None¶
-
attrib
= None¶
-
group
= None¶
-
obs
= None¶
-
series
= None¶
-
structured_by
= None¶
-
valid_from
= None¶
-
-
class
sdmx.model.
GenericTimeSeriesDataSet
[source]¶ Bases:
sdmx.model.DataSet
SDMX-IM GenericTimeSeriesDataSet.
-
action
= None¶
-
attrib
= None¶
-
group
= None¶
-
obs
= None¶
-
series
= None¶
-
structured_by
= None¶
-
valid_from
= None¶
-
-
class
sdmx.model.
GroupDimensionDescriptor
(*args, **kwargs)[source]¶ Bases:
sdmx.model.DimensionDescriptor
-
assign_order
()[source]¶ assign_order()
has no effect for GroupDimensionDescriptor.
-
attachment_constraint
: Optional[bool] = None¶
-
constraint
: Optional[AttachmentConstraint] = None¶
-
-
class
sdmx.model.
GroupKey
(arg: Mapping = None, **kwargs)[source]¶ Bases:
sdmx.model.Key
-
described_by
: Optional[GroupDimensionDescriptor] = None¶
-
id
: Optional[str] = None¶
-
-
class
sdmx.model.
GroupRelationship
[source]¶ Bases:
sdmx.model.AttributeRelationship
-
group_key
: Optional['GroupDimensionDescriptor'] = None¶
-
-
class
sdmx.model.
ISOConceptReference
[source]¶ Bases:
sdmx.util.BaseModel
-
agency
: str = None¶
-
id
: str = None¶
-
scheme_id
: str = None¶
-
-
class
sdmx.model.
IdentifiableArtefact
(*args, **kwargs)[source]¶ Bases:
sdmx.model.AnnotableArtefact
-
id
: str = None¶ Unique identifier of the object.
-
uri
: Optional[str] = None¶ Universal resource identifier that may or may not be resolvable.
-
urn
: Optional[str] = None¶ Universal resource name. For use in SDMX registries; all registered objects have a URN.
-
urn_group
: Dict = None¶
-
-
class
sdmx.model.
InternationalString
(value=None, **kwargs)[source]¶ Bases:
object
SDMX-IM InternationalString.
SDMX-IM LocalisedString is not implemented. Instead, the ‘localizations’ is a mapping where:
keys correspond to the ‘locale’ property of LocalisedString.
values correspond to the ‘label’ property of LocalisedString.
When used as a type hint with pydantic, InternationalString fields can be assigned to in one of four ways:
class Foo(BaseModel): name: InternationalString = InternationalString() # Equivalent: no localizations f = Foo() f = Foo(name={}) # Using an explicit locale f.name['en'] = "Foo's name in English" # Using a (locale, label) tuple f.name = ('fr', "Foo's name in French") # Using a dict f.name = {'en': "Replacement English name", 'fr': "Replacement French name"} # Using a bare string, implicitly for the DEFAULT_LOCALE f.name = "Name in DEFAULT_LOCALE language"
Only the first method preserves existing localizations; the latter three replace them.
-
localizations
: Dict[str, str] = {}¶
-
class
sdmx.model.
Item
(*args, **kwargs)[source]¶ Bases:
sdmx.model.NameableArtefact
-
child
: List['Item'] = None¶
-
property
hierarchical_id
¶ Construct the ID of an Item in a hierarchical ItemScheme.
Returns, for example, ‘A.B.C’ for an Item with id ‘C’ that is the child of an item with id ‘B’, which is the child of a root Item with id ‘A’.
See also
-
parent
: Optional['Item'] = None¶
-
-
class
sdmx.model.
ItemScheme
(**kwargs)[source]¶ Bases:
sdmx.model.MaintainableArtefact
,typing.Generic
SDMX-IM Item Scheme.
The IM states that ItemScheme “defines a set of
Items
…” To simplify indexing/retrieval, this implementation uses adict
for theitems
attribute, in which the keys are theid
of the Item.Because this may change in future versions of pandaSDMX, user code should not access
items
directly. Instead, use thegetattr()
and indexing features of ItemScheme, or the public methods, to access and manipulate Items:>>> foo = ItemScheme(id='foo') >>> bar = Item(id='bar') >>> foo.append(bar) >>> foo <ItemScheme: 'foo', 1 items> >>> (foo.bar is bar) and (foo['bar'] is bar) and (bar in foo) True
-
append
(item: IT)[source]¶ Add item to the ItemScheme.
- Parameters
item (same class as
items
) – Item to add.
-
get_hierarchical
(id: str) → IT[source]¶ Get an Item by its
hierarchical_id
.
-
is_partial
: Optional[bool] = None¶
-
-
class
sdmx.model.
Key
(arg: Mapping = None, **kwargs)[source]¶ Bases:
sdmx.util.BaseModel
SDMX Key class.
The constructor takes an optional list of keyword arguments; the keywords are used as Dimension or Attribute IDs, and the values as KeyValues.
For convience, the values of the key may be accessed directly:
>>> k = Key(foo=1, bar=2) >>> k.values['foo'] 1 >>> k['foo'] 1
- Parameters
dsd (DataStructureDefinition) – If supplied, the
dimensions
andattributes
are used to separate the kwargs intoKeyValues
andAttributeValues
. The kwarg fordescribed_by
, if any, must bedimensions
or appear ingroup_dimensions
.kwargs – Dimension and Attribute IDs, and/or the class properties.
-
attrib
: DictLike[str, AttributeValue] = None¶
-
copy
(arg=None, **kwargs)[source]¶ Duplicate a model, optionally choose which fields to include, exclude and change.
- Parameters
include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to True to make a deep copy of the model
- Returns
new model instance
-
described_by
: Optional[DimensionDescriptor] = None¶
-
values
: DictLike[str, KeyValue] = None¶ Individual KeyValues that describe the key.
-
class
sdmx.model.
KeyValue
(*args, **kwargs)[source]¶ Bases:
sdmx.util.BaseModel
One value in a multi-dimensional
Key
.-
id
: str = None¶
-
value
: Any = None¶ The actual value.
-
value_for
: Optional[Dimension] = None¶
-
-
class
sdmx.model.
MaintainableArtefact
(**kwargs)[source]¶ Bases:
sdmx.model.VersionableArtefact
-
is_external_reference
: Optional[bool] = None¶ True
if the content of the object is held externally; i.e., not the currentMessage
.
-
is_final
: Optional[bool] = None¶ True if the object is final; otherwise it is in a draft state.
-
maintainer
: Optional['Agency'] = None¶ Association to the Agency responsible for maintaining the object.
-
service_url
: Optional[str] = None¶ URL of an SDMX-compliant web service from which the object can be retrieved.
-
structure_url
: Optional[str] = None¶ URL of an SDMX-ML document containing the object.
-
-
class
sdmx.model.
MeasureDescriptor
(*args, **kwargs)[source]¶ Bases:
sdmx.model.ComponentList
-
components
= None¶
-
-
class
sdmx.model.
MeasureDimension
(*args, **kwargs)[source]¶ Bases:
sdmx.model.DimensionComponent
SDMX-IM MeasureDimension.
-
order
= None¶
-
-
class
sdmx.model.
MemberSelection
[source]¶ Bases:
sdmx.util.BaseModel
-
included
: bool = None¶
-
values
: Set[MemberValue] = None¶ NB the spec does not say what this feature should be named
-
values_for
: Component = None¶
-
-
class
sdmx.model.
MemberValue
[source]¶ Bases:
sdmx.model.SelectionValue
-
cascade_values
: Optional[bool] = None¶
-
value
: str = None¶
-
-
class
sdmx.model.
NameableArtefact
(*args, **kwargs)[source]¶ Bases:
sdmx.model.IdentifiableArtefact
-
description
: InternationalString = None¶ Multi-lingual description of the object.
-
name
: InternationalString = None¶ Multi-lingual name of the object.
-
-
class
sdmx.model.
Observation
[source]¶ Bases:
sdmx.util.BaseModel
SDMX-IM Observation.
This class also implements the spec classes ObservationValue, UncodedObservationValue, and CodedObservation.
-
attached_attribute
: DictLike[str, AttributeValue] = None¶
-
property
attrib
¶ Return a view of combined observation, series & group attributes.
-
property
dim
¶
-
dimension
: Optional[Key] = None¶ Key for dimension(s) varying at the observation level.
-
property
key
¶ Return the entire key, including KeyValues at the series level.
-
series_key
: Optional[SeriesKey] = None¶
-
value
: Optional[Union[Any, Code]] = None¶ Data value.
-
value_for
: Optional[PrimaryMeasure] = None¶
-
-
class
sdmx.model.
Organisation
(*args, **kwargs)[source]¶ Bases:
sdmx.model.Item
-
contact
: List[Contact] = None¶
-
-
sdmx.model.
PACKAGE
= {<class 'sdmx.model.Agency'>: 'base', <class 'sdmx.model.DataProvider'>: 'base', <class 'sdmx.model.AgencyScheme'>: 'base', <class 'sdmx.model.Category'>: 'categoryscheme', <class 'sdmx.model.Categorisation'>: 'categoryscheme', <class 'sdmx.model.CategoryScheme'>: 'categoryscheme', <class 'sdmx.model.Code'>: 'codelist', <class 'sdmx.model.Codelist'>: 'codelist', <class 'sdmx.model.Concept'>: 'conceptscheme', <class 'sdmx.model.ConceptScheme'>: 'conceptscheme', <class 'sdmx.model.DataflowDefinition'>: 'datastructure', <class 'sdmx.model.DataStructureDefinition'>: 'datastructure', <class 'sdmx.model.ContentConstraint'>: 'registry', <class 'sdmx.model.ProvisionAgreement'>: 'registry'}¶ The SDMX-IM defines ‘packages’; these are used in URNs.
-
class
sdmx.model.
PrimaryMeasure
(*args, **kwargs)[source]¶ Bases:
sdmx.model.Component
SDMX-IM PrimaryMeasure.
-
concept_identity
= None¶
-
local_representation
= None¶
-
-
class
sdmx.model.
ProvisionAgreement
(**kwargs)[source]¶ Bases:
sdmx.model.MaintainableArtefact
,sdmx.model.ConstrainableArtefact
-
data_provider
: Optional[DataProvider] = None¶
-
structure_usage
: Optional[StructureUsage] = None¶
-
-
class
sdmx.model.
QueryDatasource
[source]¶ Bases:
sdmx.model.Datasource
-
url
= None¶
-
-
class
sdmx.model.
RESTDatasource
[source]¶ Bases:
sdmx.model.QueryDatasource
-
url
= None¶
-
-
class
sdmx.model.
ReportingYearStartDay
(*args, **kwargs)[source]¶ Bases:
sdmx.model.DataAttribute
-
usage_status
= None¶
-
-
class
sdmx.model.
Representation
[source]¶ Bases:
sdmx.util.BaseModel
-
enumerated
: Optional[ItemScheme] = None¶
-
non_enumerated
: List[Facet] = None¶
-
-
class
sdmx.model.
SelectionValue
[source]¶ Bases:
sdmx.util.BaseModel
SDMX-IM SelectionValue.
-
class
sdmx.model.
SeriesKey
(arg: Mapping = None, **kwargs)[source]¶ Bases:
sdmx.model.Key
-
property
group_attrib
¶ Return a view of combined group attributes.
-
property
-
class
sdmx.model.
SimpleDatasource
[source]¶ Bases:
sdmx.model.Datasource
-
url
= None¶
-
-
class
sdmx.model.
Structure
(**kwargs)[source]¶ Bases:
sdmx.model.MaintainableArtefact
-
grouping
: Optional[ComponentList] = None¶
-
-
class
sdmx.model.
StructureSpecificDataSet
[source]¶ Bases:
sdmx.model.DataSet
SDMX-IM StructureSpecificDataSet.
-
action
= None¶
-
attrib
= None¶
-
group
= None¶
-
obs
= None¶
-
series
= None¶
-
structured_by
= None¶
-
valid_from
= None¶
-
-
class
sdmx.model.
StructureSpecificTimeSeriesDataSet
[source]¶ Bases:
sdmx.model.DataSet
SDMX-IM StructureSpecificTimeSeriesDataSet.
-
action
= None¶
-
attrib
= None¶
-
group
= None¶
-
obs
= None¶
-
series
= None¶
-
structured_by
= None¶
-
valid_from
= None¶
-
-
class
sdmx.model.
StructureUsage
(**kwargs)[source]¶ Bases:
sdmx.model.MaintainableArtefact
-
structure
: Optional[Structure] = None¶
-
-
class
sdmx.model.
TimeDimension
(*args, **kwargs)[source]¶ Bases:
sdmx.model.DimensionComponent
SDMX-IM TimeDimension.
-
order
= None¶
-
-
sdmx.model.
TimeKeyValue
¶ alias of
sdmx.model.KeyValue
-
class
sdmx.model.
VersionableArtefact
(**kwargs)[source]¶ Bases:
sdmx.model.NameableArtefact
-
valid_from
: Optional[str] = None¶ Date from which the version is valid.
-
valid_to
: Optional[str] = None¶ Date from which the version is superseded.
-
version
: Optional[str] = None¶ A version string following an agreed convention.
-
-
sdmx.model.
cls
¶ alias of
sdmx.model.Agency
reader
: Parsers for SDMX file formats¶
SDMX-ML¶
sdmx
supports the several types of SDMX-ML messages.
-
class
sdmx.reader.sdmxml.
Reader
[source]¶ -
annotable
(cls, elem, **kwargs)[source]¶ Create a AnnotableArtefact of cls from elem and kwargs.
Collects all parsed <com:Annotation>.
-
content_types
: List[str] = ['application/xml', 'application/vnd.sdmx.genericdata+xml', 'application/vnd.sdmx.structure+xml', 'application/vnd.sdmx.structurespecificdata+xml', 'text/xml']¶
-
get_single
(cls_or_name, id=None, strict=False)[source]¶ Return a reference to an object while leaving it in its stack.
Always returns 1 object. Returns None if no matching object exists, or if 2 or more objects match.
If id is given, only return an IdentifiableArtefact with the matching ID.
If cls_or_name is a class and strict is False; all objects in any stack that are instances of cls_or_name or any a subclass are collected and checked. If strict is True, only the corresponding stack is checked.
-
identifiable
(cls, elem, **kwargs)[source]¶ Create a IdentifiableArtefact of cls from elem and kwargs.
-
maintainable
(cls, elem, **kwargs)[source]¶ Create or retrieve a MaintainableArtefact of cls from elem and kwargs.
Following the SDMX-IM class hierachy,
maintainable()
callsversionable()
, which in turn callsnameable()
, etc. For all of these methods:Already-parsed items are removed from the stack only if elem is not
None
.kwargs (e.g. ‘id’) take precedence over any values retrieved from attributes of elem.
If elem is None,
maintainable()
returns a MaintainableArtefact with the is_external_reference attribute set toTrue
. Subsequent calls with the same object ID will return references to the same object.
-
nameable
(cls, elem, **kwargs)[source]¶ Create a NameableArtefact of cls from elem and kwargs.
Collects all parsed
InternationalString
localizations of <com:Name> and <com:Description>.
-
pop_all
(cls_or_name, strict=False)[source]¶ Pop all objects from stack cls_or_name and return.
If cls_or_name is a class and strict is False; all objects in any stack that are instances of cls_or_name or any a subclass are collected and returned. If strict is True, only the corresponding stack is checked.
-
read_message
(source, dsd=None)[source]¶ Read message from source.
- Parameters
source (file-like) – Message content.
dsd (DataStructureDefinition, optional) – DSD for aid in reading source.
- Returns
An instance of a Message subclass.
- Return type
-
suffixes
: List[str] = ['.xml']¶
-
SDMX-JSON¶
-
class
sdmx.reader.sdmxjson.
Reader
[source]¶ Read SDMXJSON 2.1 and expose it as instances from
sdmx.model
.-
content_types
: List[str] = ['application/vnd.sdmx.draft-sdmx-json+json', 'draft-sdmx-json', 'text/json']¶
-
read_message
(source, dsd=None)[source]¶ Read message from source.
- Parameters
source (file-like) – Message content.
dsd (DataStructureDefinition, optional) – DSD for aid in reading source.
- Returns
An instance of a Message subclass.
- Return type
-
suffixes
: List[str] = ['.json']¶
-
Reader API¶
-
sdmx.reader.
CTYPE_READER
: Mapping[str, Type] = {'application/vnd.sdmx.draft-sdmx-json+json': <class 'sdmx.reader.sdmxjson.Reader'>, 'application/vnd.sdmx.genericdata+xml': <class 'sdmx.reader.sdmxml.Reader'>, 'application/vnd.sdmx.structure+xml': <class 'sdmx.reader.sdmxml.Reader'>, 'application/vnd.sdmx.structurespecificdata+xml': <class 'sdmx.reader.sdmxml.Reader'>, 'application/xml': <class 'sdmx.reader.sdmxml.Reader'>, 'draft-sdmx-json': <class 'sdmx.reader.sdmxjson.Reader'>, 'text/json': <class 'sdmx.reader.sdmxjson.Reader'>, 'text/xml': <class 'sdmx.reader.sdmxml.Reader'>}¶ Mapping from HTTP content type to reader class.
-
sdmx.reader.
READERS
: List[Type] = [<class 'sdmx.reader.sdmxjson.Reader'>, <class 'sdmx.reader.sdmxml.Reader'>]¶ Reader classes
-
sdmx.reader.
SUFFIX_READER
: Mapping[str, Type] = {'.json': <class 'sdmx.reader.sdmxjson.Reader'>, '.xml': <class 'sdmx.reader.sdmxml.Reader'>}¶ Mapping from file path suffix to reader class.
-
sdmx.reader.
detect_content_reader
(content)[source]¶ Return a reader class for content.
The
BaseReader.detect()
method for each class inREADERS
is called; if a reader signals that it is compatible with content, then that class is returned.- Raises
ValueError – If no reader class matches.
-
sdmx.reader.
get_reader_for_content_type
(ctype)[source]¶ Return a reader class for HTTP content type content.
- Raises
ValueError – If no reader class matches.
See also
-
sdmx.reader.
get_reader_for_path
(path)[source]¶ Return a reader class for file path.
- Raises
ValueError – If no reader class matches.
See also
-
sdmx.reader.
read_sdmx
(filename_or_obj, format=None, **kwargs)[source]¶ Load a SDMX-ML or SDMX-JSON message from a file or file-like object.
- Parameters
filename_or_obj (str or
PathLike
or file) –format ('XML' or 'JSON', optional) –
- Other Parameters
dsd (
DataStructureDefinition
) – For “structure-specific” format`=``XML` messages only.
-
class
sdmx.reader.base.
BaseReader
[source]¶ -
content_types
: List[str] = []¶ List of HTTP content types handled by the reader.
-
abstract
read_message
(source, dsd=None)[source]¶ Read message from source.
- Parameters
source (file-like) – Message content.
dsd (DataStructureDefinition, optional) – DSD for aid in reading source.
- Returns
An instance of a Message subclass.
- Return type
-
suffixes
: List[str] = []¶ List of file name suffixes handled by the reader.
-
writer
: Convert sdmx
objects to other formats¶
writer.pandas
: Convert to pandas
objects¶
Changed in version 1.0: sdmx.to_pandas()
handles all types of objects, replacing the earlier, separate data2pandas
and structure2pd
writers.
to_pandas()
implements a dispatch pattern according to the type of obj.
Some of the internal methods take specific arguments and return varying values.
These arguments can be passed to to_pandas()
when obj is of the appropriate type:
|
Convert |
|
Convert |
|
Convert |
Convert |
|
Default return type for |
Other objects are converted as follows:
Component
The
id
attribute of theconcept_identity
is returned.DataMessage
The
DataSet
or data sets within the Message are converted to pandas objects. Returns:pandas.Series
orpandas.DataFrame
, if obj has only one data set.list of (Series or DataFrame), if obj has more than one data set.
dict
The values of the mapping are converted individually. If the resulting values are
str
or Series with indexes that share the same name, then they are converted to a Series, possibly with apandas.MultiIndex
. Otherwise, aDictLike
is returned.DimensionDescriptor
The
components
of the DimensionDescriptor are written.list
For the following obj, returns Series instead of a
list
:a list of
Observation
: the Observations are written usingwrite_dataset()
.a list with only 1
DataSet
(e.g. thedata
attribute ofDataMessage
): the Series for the single element is returned.a list of
SeriesKey
: the key values (but no data) are returned.
NameableArtefact
The
name
attribute of obj is returned.
-
sdmx.writer.pandas.
DEFAULT_RTYPE
= 'rows'¶ Default return type for
write_dataset()
and similar methods. Either ‘compat’ or ‘rows’. See the ref:HOWTO <howto-rtype>.
-
sdmx.writer.pandas.
write_dataset
(obj: sdmx.model.DataSet, attributes='', dtype=<class 'numpy.float64'>, constraint=None, datetime=False, **kwargs)[source]¶ Convert
DataSet
.See the walkthrough for examples of using the datetime argument.
- Parameters
obj (
DataSet
or iterable ofObservation
) –attributes (str) –
Types of attributes to return with the data. A string containing zero or more of:
'o'
: attributes attached to eachObservation
.'s'
: attributes attached to any (0 or 1)SeriesKey
associated with each Observation.'g'
: attributes attached to any (0 or more)GroupKey
associated with each Observation.'d'
: attributes attached to theDataSet
containing the Observations.
dtype (str or
numpy.dtype
or None) – Datatype for values. If None, do not return the values of a series. In this case, attributes must not be an empty string so that some attribute is returned.constraint (ContentConstraint, optional) – If given, only Observations included by the constraint are returned.
datetime (bool or str or or .Dimension or dict, optional) –
If given, return a DataFrame with a
DatetimeIndex
orPeriodIndex
as the index and all other dimensions as columns. Valid datetime values include:bool
: ifTrue
, determine the time dimension automatically by detecting aTimeDimension
.str
: ID of the time dimension.Dimension
: the matching Dimension is the time dimension.dict
: advanced behaviour. Keys may include:axis ({0 or ‘index’, 1 or ‘columns’}): axis on which to place the time dimension (default: 0).
freq (
True
orstr
orDimension
): producepandas.PeriodIndex
. Ifstr
, the ID of a Dimension containing a frequency specification. If a Dimension, the specified dimension is used for the frequency specification.Any Dimension used for the frequency specification is does not appear in the returned DataFrame.
- Returns
-
if attributes is not
''
, a data frame with one row per Observation,value
as the first column, and additional columns for each attribute;if datetime is given, various layouts as described above; or
if _rtype (passed from
write_datamessage()
) is ‘compat’, various layouts as described in the HOWTO.
pandas.Series
withpandas.MultiIndex
– Otherwise.
-
-
sdmx.writer.pandas.
write_datamessage
(obj: sdmx.message.DataMessage, *args, rtype=None, **kwargs)[source]¶ Convert
DataMessage
.- Parameters
rtype ('compat' or 'rows', optional) – Data type to return; default
DEFAULT_RTYPE
. See the HOWTO.kwargs – Passed to
write_dataset()
for each data set.
- Returns
pandas.Series
orpandas.DataFrame
– if obj has only one data set.list of (
pandas.Series
orpandas.DataFrame
) – if obj has more than one data set.
-
sdmx.writer.pandas.
write_itemscheme
(obj: sdmx.model.ItemScheme, locale='en')[source]¶ Convert
ItemScheme
.- Parameters
locale (str, optional) – Locale for names to return.
- Returns
- Return type
-
sdmx.writer.pandas.
write_structuremessage
(obj: sdmx.message.StructureMessage, include=None, **kwargs)[source]¶ Convert
StructureMessage
.- Parameters
obj (StructureMessage) –
include (iterable of str or str, optional) – One or more of the attributes of the StructureMessage ( ‘category_scheme’, ‘codelist’, etc.) to transform.
kwargs – Passed to
write()
for each attribute.
- Returns
Keys are StructureMessage attributes; values are pandas objects.
- Return type
Todo
Support selection of language for conversion of
InternationalString
.
remote
: Access SDMX REST web services¶
-
class
sdmx.remote.
Session
(timeout=30.1, proxies=None, stream=False, **kwargs)[source]¶ requests.Session
subclass with optional caching.If requests_cache is installed, this class caches responses.
-
class
sdmx.remote.
ResponseIO
(response, tee=None)[source]¶ Buffered wrapper for
requests.Response
with optional file output.ResponseIO
wraps arequests.Response
object’s ‘content’ attribute, providing a file-like object from which bytes can beread()
incrementally.- Parameters
response (
requests.Response
) – HTTP response to wrap.tee (binary, writable
io.BufferedIOBasè
, defaults to io.BytesIO()) – tee is exposed as self.tee and not closed explicitly.
source
: Features of SDMX data sources¶
This module defines Source
and some utility functions.
For built-in subclasses of Source used to provide sdmx
’s built-in support
for certain data sources, see Data sources.
-
class
sdmx.source.
Source
(**kwargs)[source]¶ SDMX-IM RESTDatasource.
This class describes the location and features supported by an SDMX data source. Subclasses may override the hooks in order to handle specific features of different REST web services:
handle_response
(response, content)Handle response content of unknown type.
finish_message
(message, request, **kwargs)Postprocess retrieved message.
modify_request_args
(kwargs)Modify arguments used to build query URL.
-
data_content_type
: DataContentType = None¶ DataContentType
indicating the type of data returned by the source.
-
finish_message
(message, request, **kwargs)[source]¶ Postprocess retrieved message.
This hook is called by
Request.get()
after aMessage
object has been successfully parsed from the query response.See
estat.Source.finish_message()
for an example implementation.
-
handle_response
(response, content)[source]¶ Handle response content of unknown type.
This hook is called by
Request.get()
only when the content cannot be parsed as XML or JSON.See
estat.Source.handle_response()
andsgr.Source.handle_response()
for example implementations.
-
id
: str = None¶ ID of the data source
-
modify_request_args
(kwargs)[source]¶ Modify arguments used to build query URL.
This hook is called by
Request.get()
to modify the keyword arguments before the query URL is built.The default implementation handles requests for ‘structure-specific data’ by adding an HTTP ‘Accepts:’ header when a ‘dsd’ is supplied as one of the kwargs.
See
sgr.Source.modify_request_args()
for an example override.- Returns
- Return type
-
name
: str = None¶ Human-readable name of the data source
-
supports
: Dict[Union[str, Resource], bool] = None¶ Mapping from
Resource
tobool
indicating support for SDMX REST API features. Two additional keys are valid:'preview'=True
if the source supports?detail=serieskeysonly
. Seepreview_data()
.'structure-specific data'=True
if the source can return structure- specific data messages.
-
url
: str = None¶ Base URL for queries
-
-
sdmx.source.
add_source
(info, id=None, override=False, **kwargs)[source]¶ Add a new data source.
The info expected is in JSON format:
{ "id": "ESTAT", "documentation": "http://data.un.org/Host.aspx?Content=API", "url": "http://ec.europa.eu/eurostat/SDMX/diss-web/rest", "name": "Eurostat", "supported": {"codelist": false, "preview": true} }
…with unspecified values using the defaults; see
Source
.- Parameters
info (dict-like) – String containing JSON information about a data source.
id (str) – Identifier for the new datasource. If
None
(default), then info[‘id’] is used.override (bool) – If
True
, replace any existing data source with id. Otherwise, raiseValueError
.**kwargs – Optional callbacks for handle_response and finish_message hooks.
util
: Utilities¶
-
class
sdmx.util.
BaseModel
[source]¶ Bases:
pydantic.main.BaseModel
Shim for pydantic.BaseModel.
This class changes two behaviours in pydantic. The methods are direct copies from pydantic’s code, with marked changes.
https://github.com/samuelcolvin/pydantic/issues/524
“Multiple RecursionErrors with self-referencing models”
In e.g.
Item
, having both .parent and .child references leads to infinite recursion during validation.Fix: override BaseModel.__setattr__.
New value ‘limited’ for Config.validate_assignment: no sibling field values are passed to Field.validate().
New key Config.validate_assignment_exclude: list of field names that are not validated per se and not passed to Field.validate() when validating a sibling field.
https://github.com/samuelcolvin/pydantic/issues/521
“Assignment to attribute changes id() but not referenced object,” marked as wontfix by pydantic maintainer.
When cls.attr is typed as BaseModel (or a subclass), then a.attr is b.attr is always False, even when set to the same reference.
Fix: override BaseModel.validate() without copy().
-
class
sdmx.util.
DictLike
[source]¶ Bases:
collections.OrderedDict
,collections.abc.MutableMapping
,typing.Generic
Container with features of a dict & list, plus attribute access.
-
class
sdmx.util.
Resource
[source]¶ -
Enumeration of SDMX REST API endpoints.
Enum
membersdmx.model
classcategoryscheme
codelist
conceptscheme
data
dataflow
datastructure
provisionagreement
-
categoryscheme
= 'categoryscheme'¶
-
codelist
= 'codelist'¶
-
conceptscheme
= 'conceptscheme'¶
-
data
= 'data'¶
-
dataflow
= 'dataflow'¶
-
datastructure
= 'datastructure'¶
-
provisionagreement
= 'provisionagreement'¶
-