API Reference¶
SyncData¶
Note
All methods of this instance can be accessed from the root pnwkit module. I.e. pnwkit.ext.dumps.request_as_dict
as opposed to pnwkit.ext.dumps.request_as_dict
.
- class pnwkit.ext.dumps.sync.SyncData¶
- classmethod request_as_bytes(type_: str, date: str) → bytes¶
Returns the requested CSV as bytes.
- Parameters
type (str) – The type of data to request. Accepts “alliances”, “cities”, “nations”, “trades”, or “wars”.
date (str) – The date of the data to request. Accepts the format
YYYY-MM-DD
.
- Returns
The bytes of the requested CSV.
- Return type
bytes
- classmethod request_as_csv(type_: str, date: str) → _reader¶
Returns the requested CSV as a
csv._reader
.- Parameters
type (str) – The type of data to request. Accepts alliances, cities, nations, trades, or wars.
date (str) – The date of the data to request. Accepts the format
YYYY-MM-DD
.
- Returns
The CSV reader of the requested CSV.
- Return type
csv._reader
- classmethod request_as_data(type_: str, date: str) → Tuple[pnwkit.ext.dumps.data.DumpData, ...]¶
Returns the requested CSV as a tuple of
pnw_dumps.data.DumpData
corresponding to the type of data requested.- Parameters
type (str) – The type of data to request. Accepts alliances, cities, nations, trades, or wars.
date (str) – The date of the data to request. Accepts the format
YYYY-MM-DD
.
- Returns
The tuple of
pnw_dumps.data.DumpData
corresponding to the type of data requested.- Return type
Tuple[DumpData, …]
- classmethod request_as_data_dict(type_: str, date: str) → Dict[str, pnwkit.ext.dumps.data.DumpData]¶
Returns the requested CSV as a tuple of
pnw_dumps.data.DumpData
corresponding to the type of data requested indexed by ID.- Parameters
type (str) – The type of data to request. Accepts alliances, cities, nations, trades, or wars.
date (str) – The date of the data to request. Accepts the format
YYYY-MM-DD
.
- Returns
The dict of
pnw_dumps.data.DumpData
corresponding to the type of data requested indexed by ID.- Return type
Dict[str, DumpData]
- classmethod request_as_dict(type_: str, date: str) → Dict[str, Dict[str, Any]]¶
Returns the requested CSV as a
dict
indexed by ID.- Parameters
type (str) – The type of data to request. Accepts alliances, cities, nations, trades, or wars.
date (str) – The date of the data to request. Accepts the format
YYYY-MM-DD
.
- Returns
The dict of the requested CSV.
- Return type
Dict[str, Any]
- classmethod request_as_dicts(type_: str, date: str) → Sequence[Dict[str, Any]]¶
Returns the requested CSV as a list of
dict
.- Parameters
type (str) – The type of data to request. Accepts alliances, cities, nations, trades, or wars.
date (str) – The date of the data to request. Accepts the format
YYYY-MM-DD
.
- Returns
The list of dicts of the requested CSV.
- Return type
Sequence[Dict[str, Any]]
- classmethod request_as_str(type_: str, date: str) → str¶
Returns the requested CSV as a string.
- Parameters
type (str) – The type of data to request. Accepts
alliances
,cities
,nations
,trades
, orwars
.date (str) – The date of the data to request. Accepts the format
YYYY-MM-DD
.
- Returns
The string of the requested CSV.
- Return type
str
AsyncData¶
Note
All methods of this instance can be accessed from the root pnwkit module with prefix async_
. I.e. pnwkit.ext.dumps.async_request_as_dict
as opposed to pnwkit.ext.dumps.async_request_as_dict
.
- class pnwkit.ext.dumps.async_.AsyncData¶
- async classmethod request_as_bytes(type_: str, date: str) → bytes¶
Returns the requested CSV as bytes.
- Parameters
type (str) – The type of data to request. Accepts “alliances”, “cities”, “nations”, “trades”, or “wars”.
date (str) – The date of the data to request. Accepts the format
YYYY-MM-DD
.
- Returns
The bytes of the requested CSV.
- Return type
bytes
- async classmethod request_as_csv(type_: str, date: str) → _reader¶
Returns the requested CSV as a
csv._reader
.- Parameters
type (str) – The type of data to request. Accepts alliances, cities, nations, trades, or wars.
date (str) – The date of the data to request. Accepts the format
YYYY-MM-DD
.
- Returns
The CSV reader of the requested CSV.
- Return type
csv._reader
- async classmethod request_as_data(type_: str, date: str) → Tuple[pnwkit.ext.dumps.data.DumpData, ...]¶
Returns the requested CSV as a tuple of
pnw_dumps.data.DumpData
corresponding to the type of data requested.- Parameters
type (str) – The type of data to request. Accepts alliances, cities, nations, trades, or wars.
date (str) – The date of the data to request. Accepts the format
YYYY-MM-DD
.
- Returns
The tuple of
pnw_dumps.data.DumpData
corresponding to the type of data requested.- Return type
Tuple[DumpData, …]
- async classmethod request_as_data_dict(type_: str, date: str) → Dict[str, pnwkit.ext.dumps.data.DumpData]¶
Returns the requested CSV as a tuple of
pnw_dumps.data.DumpData
corresponding to the type of data requested indexed by ID.- Parameters
type (str) – The type of data to request. Accepts alliances, cities, nations, trades, or wars.
date (str) – The date of the data to request. Accepts the format
YYYY-MM-DD
.
- Returns
The dict of
pnw_dumps.data.DumpData
corresponding to the type of data requested indexed by ID.- Return type
Dict[str, DumpData]
- async classmethod request_as_dict(type_: str, date: str) → Dict[str, Dict[str, Any]]¶
Returns the requested CSV as a
dict
indexed by ID.- Parameters
type (str) – The type of data to request. Accepts alliances, cities, nations, trades, or wars.
date (str) – The date of the data to request. Accepts the format
YYYY-MM-DD
.
- Returns
The dict of the requested CSV.
- Return type
Dict[str, Any]
- async classmethod request_as_dicts(type_: str, date: str) → Sequence[Dict[str, Any]]¶
Returns the requested CSV as a list of
dict
.- Parameters
type (str) – The type of data to request. Accepts alliances, cities, nations, trades, or wars.
date (str) – The date of the data to request. Accepts the format
YYYY-MM-DD
.
- Returns
The list of dicts of the requested CSV.
- Return type
Sequence[Dict[str, Any]]
- async classmethod request_as_str(type_: str, date: str) → str¶
Returns the requested CSV as a string.
- Parameters
type (str) – The type of data to request. Accepts
alliances
,cities
,nations
,trades
, orwars
.date (str) – The date of the data to request. Accepts the format
YYYY-MM-DD
.
- Returns
The string of the requested CSV.
- Return type
str