نتیجه، تنظیمات و نوع‌های شمارشی#

FetchResult#

class oxtapus.api.results.FetchResult(data, capability, provider, endpoint, query, retrieved_at, elapsed, retry_count, warnings, failures, source_schema_version, canonical_schema_version, data_layer, lineage, quality_summary)[source]#

دیتافریم استاندارد همراه فرادادهٔ دریافت، گزارش کیفیت و lineage.

Parameters:
classmethod from_service(result)[source]#

یک نتیجهٔ application service را به قرارداد عمومی پایدار تبدیل می‌کند.

Parameters:

result (ServiceResult)

Return type:

FetchResult

to_polars()[source]#

یک نسخهٔ کم‌هزینه از دیتافریم Polars برمی‌گرداند.

Return type:

DataFrame

to_lazy()[source]#

یک LazyFrame روی نتیجهٔ موجود در حافظه برمی‌گرداند.

Return type:

LazyFrame

to_arrow()[source]#

نتیجه را به Arrow تبدیل می‌کند؛ extra با نام arrow لازم است.

Return type:

Any

to_pandas()[source]#

نتیجه را به Pandas تبدیل می‌کند؛ extraهای pandas و arrow لازم‌اند.

Return type:

Any

to_records()[source]#

ردیف‌ها را به‌ترتیب به‌شکل فهرستی از دیکشنری‌های پایتون برمی‌گرداند.

Return type:

list[dict[str, Any]]

Settings#

class oxtapus.api.settings.Settings(_case_sensitive=None, _nested_model_default_partial_update=None, _env_prefix=None, _env_prefix_target=None, _env_file=PosixPath('.'), _env_file_encoding=None, _env_ignore_empty=None, _env_nested_delimiter=None, _env_nested_max_split=None, _env_parse_none_str=None, _env_parse_enums=None, _cli_prog_name=None, _cli_parse_args=None, _cli_settings_source=None, _cli_parse_none_str=None, _cli_hide_none_type=None, _cli_avoid_json=None, _cli_enforce_required=None, _cli_use_class_docs_for_groups=None, _cli_show_env_vars=None, _cli_exit_on_error=None, _cli_prefix=None, _cli_flag_prefix_char=None, _cli_implicit_flags=None, _cli_ignore_unknown_args=None, _cli_kebab_case=None, _cli_shortcuts=None, _secrets_dir=None, _build_sources=None, *, provider='tsetmc', endpoint_priority=('tsetmc',), base_urls=('https://cdn.tsetmc.com', 'https://api.tgju.org'), user_agent='Oxtapus/1.2 (+https://github.com/yghaderi/oxtapus)', http2=False, verify_tls=True, proxy=None, connect_timeout=5.0, read_timeout=30.0, write_timeout=10.0, pool_timeout=5.0, max_connections=10, max_keepalive_connections=5, concurrency=4, requests_per_second=2.0, retry_max_attempts=4, retry_base_delay=0.5, retry_max_delay=15.0, retry_total_delay_budget=30.0, progress=False, cache_directory=PosixPath('.oxtapus/cache'), data_directory=PosixPath('.oxtapus/data'), storage_backend='memory', persisted_data_layers=(), schema_policy=SchemaPolicy.REPORT, quality_policy='report', failure_mode=FailureMode.COLLECT, freshness_seconds=300, logging_enabled=False, telemetry_enabled=False)[source]#

Bases: BaseSettings

تنظیمات اجرا با اولویت آرگومان، متغیر محیطی و سپس مقدار پیش‌فرض.

Parameters:

  • _case_sensitive (bool | None)

  • _nested_model_default_partial_update (bool | None)

  • _env_prefix (str | None)

  • _env_prefix_target (EnvPrefixTarget | None)

  • _env_file (DotenvType | None)

  • _env_file_encoding (str | None)

  • _env_ignore_empty (bool | None)

  • _env_nested_delimiter (str | None)

  • _env_nested_max_split (int | None)

  • _env_parse_none_str (str | None)

  • _env_parse_enums (bool | None)

  • _cli_prog_name (str | None)

  • _cli_parse_args (bool | list[str] | tuple[str, ...] | None)

  • _cli_settings_source (CliSettingsSource[Any] | None)

  • _cli_parse_none_str (str | None)

  • _cli_hide_none_type (bool | None)

  • _cli_avoid_json (bool | None)

  • _cli_enforce_required (bool | None)

  • _cli_use_class_docs_for_groups (bool | None)

  • _cli_show_env_vars (bool | None)

  • _cli_exit_on_error (bool | None)

  • _cli_prefix (str | None)

  • _cli_flag_prefix_char (str | None)

  • _cli_implicit_flags (bool | Literal['dual', 'toggle'] | None)

  • _cli_ignore_unknown_args (bool | None)

  • _cli_kebab_case (bool | Literal['all', 'no_enums'] | None)

  • _cli_shortcuts (Mapping[str, str | list[str]] | None)

  • _secrets_dir (PathType | None)

  • _build_sources (tuple[tuple[PydanticBaseSettingsSource, ...], dict[str, Any]] | None)

  • provider (str)

  • endpoint_priority (tuple[str, ...])

  • base_urls (tuple[str, ...])

  • user_agent (str)

  • http2 (bool)

  • verify_tls (bool)

  • proxy (str | None)

  • connect_timeout (float)

  • read_timeout (float)

  • write_timeout (float)

  • pool_timeout (float)

  • max_connections (int)

  • max_keepalive_connections (int)

  • concurrency (int)

  • requests_per_second (float)

  • retry_max_attempts (int)

  • retry_base_delay (float)

  • retry_max_delay (float)

  • retry_total_delay_budget (float)

  • progress (bool)

  • cache_directory (Path)

  • data_directory (Path)

  • storage_backend (str)

  • persisted_data_layers (tuple[DataLayer, ...])

  • schema_policy (SchemaPolicy)

  • quality_policy (str)

  • failure_mode (FailureMode)

  • freshness_seconds (int)

  • logging_enabled (bool)

  • telemetry_enabled (bool)

DataLayer#

class oxtapus.domain.enums.DataLayer(*values)[source]#

یکی از لایه‌های مادی خط لولهٔ مهندسی داده.

ProviderCapability#

class oxtapus.domain.enums.ProviderCapability(*values)[source]#

قابلیت‌های استاندارد فراهم‌کننده که Oxtapus ارائه می‌کند.

FailureMode#

class oxtapus.domain.enums.FailureMode(*values)[source]#

رفتار موردنظر هنگام شکست در پردازش گروهی.