gmocoin.common package¶
Submodules¶
gmocoin.common.annotation module¶
-
gmocoin.common.annotation.post_request(Schema, interval: float = 0.1, retry_count: int = 10)¶ - リクエスト後の処理を実施するラッパー関数。
ステータス200のチェック 1秒間のリクエスト上限を超えた場合のリトライをする
- パラメータ
interval -- リトライ間隔秒数
retry_count -- リトライ回数
- 戻り値
_decoratorの返り値
gmocoin.common.const module¶
-
class
gmocoin.common.const.ConstMeta¶ ベースクラス:
typeクラス定義そのものに対してのsetter制御用メタクラスです。
gmocoin.common.dto module¶
-
class
gmocoin.common.dto.AssetSymbol(value)¶ ベースクラス:
enum.Enum資産銘柄種別を示します。
-
BAT= 'BAT'¶
-
BCH= 'BCH'¶
-
BTC= 'BTC'¶
-
ETH= 'ETH'¶
-
JPY= 'JPY'¶
-
LTC= 'LTC'¶
-
OMG= 'OMG'¶
-
XEM= 'XEM'¶
-
XLM= 'XLM'¶
-
XRP= 'XRP'¶
-
-
class
gmocoin.common.dto.BaseResponse(status: int, responsetime: str)¶ ベースクラス:
objectベースレスポンスクラスです。
-
class
gmocoin.common.dto.BaseResponseSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)¶ ベースクラス:
gmocoin.common.dto.BaseSchemaベースレスポンススキーマクラスです。
-
opts= <marshmallow.schema.SchemaOpts object>¶
-
-
class
gmocoin.common.dto.BaseSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)¶ ベースクラス:
marshmallow.schema.Schemaベーススキーマクラスです。
-
opts= <marshmallow.schema.SchemaOpts object>¶
-
to_dto(data, **_)¶ dto変換関数です。
- パラメータ
data --
**_ --
-
-
class
gmocoin.common.dto.ErrorResponse(status: int, responsetime: str, messages: List[gmocoin.common.dto.Message])¶ ベースクラス:
gmocoin.common.dto.BaseResponseメッセージレスポンスクラスです。
-
class
gmocoin.common.dto.ErrorResponseResSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)¶ ベースクラス:
gmocoin.common.dto.BaseResponseSchemaメッセージレスポンススキーマクラスです。
-
opts= <marshmallow.schema.SchemaOpts object>¶
-
-
class
gmocoin.common.dto.ExecutionType(value)¶ ベースクラス:
enum.Enum注文タイプを示します。
-
LIMIT= 'LIMIT'¶
-
MARKET= 'MARKET'¶
-
STOP= 'STOP'¶
-
-
class
gmocoin.common.dto.Message(message_code: str, message_string: str)¶ ベースクラス:
objectメッセージクラスです。
-
class
gmocoin.common.dto.MessageSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)¶ ベースクラス:
gmocoin.common.dto.BaseSchemaメッセージスキーマクラスです。
-
opts= <marshmallow.schema.SchemaOpts object>¶
-
-
class
gmocoin.common.dto.OrderStatus(value)¶ ベースクラス:
enum.Enum注文ステータスを示します。
-
CANCELED= 'CANCELED'¶
-
CANCELLING= 'CANCELLING'¶
-
EXECUTED= 'EXECUTED'¶
-
EXPIRED= 'EXPIRED'¶
-
MODIFYING= 'MODIFYING'¶
-
ORDERED= 'ORDERED'¶
-
WAITING= 'WAITING'¶
-
-
class
gmocoin.common.dto.OrderType(value)¶ ベースクラス:
enum.Enum取引区分を示します。
-
LOSSCUT= 'LOSSCUT'¶
-
NORMAL= 'NORMAL'¶
-
-
class
gmocoin.common.dto.SettleType(value)¶ ベースクラス:
enum.Enum決済区分を示します。
-
CLOSE= 'CLOSE'¶
-
OPEN= 'OPEN'¶
-
-
class
gmocoin.common.dto.Status(value)¶ ベースクラス:
enum.EnumGMOサーバの状態を示します。
-
MAINTENANCE= 'MAINTENANCE'¶
-
OPEN= 'OPEN'¶
-
PREOPEN= 'PREOPEN'¶
-
gmocoin.common.exception module¶
-
exception
gmocoin.common.exception.GmoCoinException(status_code: int, messageg: gmocoin.common.dto.ErrorResponse = None)¶ ベースクラス:
Exception例外クラスです。
gmocoin.common.logging module¶
-
gmocoin.common.logging.get_log_path() → str¶ ログの出力ファイルを取得します。
- 戻り値
- 戻り値の型
output file path(str)
-
gmocoin.common.logging.get_logger() → logging.Logger¶ logging.Loggerを作成します。
- 戻り値
logging.Loggerのインスタンス
- 戻り値の型
logger (logging.Logger)
-
gmocoin.common.logging.log(logger, log_func_args: bool = True)¶ デコレーターでloggerを引数にとるためのラッパー関数
- パラメータ
logger (logging.Logger) --
log_func_args (bool) --
- 戻り値
_decoratorの返り値
-
gmocoin.common.logging.set_log_dir(dir: str) → None¶ ログの出力ディレクトリを指定します。
- パラメータ
dir (str) -- ログの出力ディレクトリ