Astropyコアソフトウェアパッケージユーティリティ (astropy.utils ）

序言：序言

♪the astropy.utils パッケージは汎用ユーティリティ関数とクラスを含む.例としては、データ構造、URLからダウンロードおよびキャッシュするためのツール、およびバージョン相互互換性機能が含まれる。

この機能は天文学専用ではないが，主にAstropy開発者に利用されている.これは、ユーザにとって安全であるが、関数およびクラスは、一般に、より複雑であるか、またはAstropyの特定の要件に特定される。

これらのユーティリティの多くは独立して袋をつかむ性質であり，通常それらの文書文字列でそれらをよりよく理解することができるため，本稿では通常他のパッケージのように詳細な部分はない.例外は以下のとおりである.

• IERSデータアクセス (astropy.utils.iers ）
• ダウンロード可能なデータ管理 (astropy.utils.data ）

注釈

♪the astropy.utils.compat 本稿のプロファイルにはサブパックは含まれていない.これには、古い/より新しいバージョンのpythonおよびnumpyと互換性のあるユーティリティモジュールが含まれており、stdlibに非常に重要なエラー修復が含まれています。 astropy それがそうです。提案開発者は少なくともこのサブルーチンパッケージのソースコードを閲覧するが，バージョンに特化したコードを多く含むため，その大部分のコンテンツがここに確実に含まれていることはできない.その内容は内部のみのご利用となっております astropy また，反対せずに変更することができる.外部パッケージやコードで使用しないでください。

参照/API

Asterpy.utils.codegenモジュール

実行時に新しいPythonコードを生成するためのユーティリティ。

機能

make_function_with_signature \(関数[, args, ...] )

既存の関数から必要な署名を持つ新しい関数を作成する.

Asterpy.utils.Collectionモジュール

専用集合クラスを含むモジュール.

クラス

HomogeneousList \(タイプ)[, values] )

所与のタイプまたは複数のタイプの要素のみを含むListのサブクラス。

Asterpy.utils.コンソールモジュール

コンソールの入出力のためのユーティリティ。

機能

isatty \(ファイル)	返品 True もし file TTYです。
color_print \(*パラメータ[, end] )	ANSI変換シーケンスを用いて色およびパターンを端子に印刷する。
human_time \(秒)	友好的な時間文字列を返すと，その長さはつねにちょうど6文字である.
human_file_size \(サイズ)	長さ2~4文字のファイルサイズを表す友好文字列を返す。
print_code_line \(行[, col, file, tabwidth, ...] )	行のソースコードを印刷し、その行の特定の文字位置を強調表示します。
terminal_size \([file] )	終端高さおよび幅を含むタプル(高さ、幅)を返す。

クラス

ProgressBar \(合計_個または_個の項目[, ...] )	端末にプログレスバーのクラスを表示する.
Spinner \(メッセージ[, color, file, step, chars] )	端末内にマイクロコーディネータを表示するためのクラス。
ProgressBarOrSpinner \(合計，メッセージ[, color, file] )	1つは1つのクラスを示しています ProgressBar あるいは…。 Spinner これは，操作の総サイズが既知であるかどうかに依存する.

Asterpy.utils.data_infoモジュール

このモジュールは、datainfoクラスに関連する関数および方法を含み、このモジュールは、情報属性および要約情報方法にコンテナを提供する。

1つのdatainfoオブジェクトは、AsterpyにQuantity、SkyCoord、Timeクラスに付加される。ここでは、これらのクラスをテーブルで使用することを可能にし、名前、フォーマット、データタイプ、メタ、および説明のようなテーブル列属性を統一的に搬送することを可能にする。

機能

data_info_factory \(名前，機能)	工場を作って使用することができます option データオブジェクト要約情報を出力するために用いられる.
dtype_info_name \(dtype)	人間本位の文字列名を返す dtype Arg.

クラス

BaseColumnInfo \([bound] )	プラスターテーブル内の列の基本情報クラスであってもよい。
DataInfo \([bound] )	データ類は追加するために使用されます info 属性は、データ属性を統一的かつ移植可能な方法で格納するために使用される。
MixinInfo \([bound] )
ParentDtypeInfo \([bound] )	親レベルからinfo.dtypeのMixinを取得する

Asterpy.utils.修飾器モジュール

様々な機能とクラス装飾者。

機能

deprecated \(なぜなら[, message, name, ...] )	関数またはクラスを破棄されたと表記するために使用される。
deprecated_attribute \(名前，自[, message, ...] )	公共属性を破棄されたと表記するために用いられる.
deprecated_renamed_argument \(旧_名，...[, ...] )	ご利用はお勧めしておりません _renamed_ あるいは…。 _removed_ 関数パラメータ。
format_doc \(文書文字列，*args, * *kwargs)	修飾対象の文書文字列を置き換え，それをフォーマットする.

クラス

classproperty \([fget, doc, lazy] )	似たような property ただし，クラスクラス属性を許す.
lazyproperty \(fget[, fset, fdel, doc] )	その動作方式はproperty()に類似しているが，一度だけ値を計算する.
sharedmethod \	これは例示的な方法と classmethod 同じ名前を共有する。

Asterpy.utils.diffモジュール

機能

diff_values \(a，b[, rtol, atol] )	2つのスカラー値を比較する.
report_diff_values \(a，b[, fileobj, indent_width] )	2つの値間の差分レポートを指定された類似ファイルのオブジェクトに書き込む.
where_not_allclose \(a，b[, rtol, atol] )	1バージョンの numpy.allclose() これは、ブール値だけではなく、2つの配列の異なるインデックスを返す。

Asterpy.utils.Exceptionsモジュール

このモジュールには，占星術に関する一般的に使用されている誤り/異常と警告が含まれている.固定子パッケージに固有の異常対応 not ここでは、特定のサブパッケージではありません。

クラス

AstropyWarning \	すべてのAstropy警告はそれから継承された基本警告クラスでなければならない。
AstropyUserWarning \	Astropyの主な警告クラス。
AstropyDeprecationWarning \	機能を破棄した警告クラスを指示する.
AstropyPendingDeprecationWarning \	廃棄されるべき機能を示すための警告クラス。
AstropyBackwardsIncompatibleChangeWarning \	占星術における以前のバージョンと互換性のない変更を示す警告クラス。
DuplicateRepresentationWarning \	名前を示す警告クラスが登録されている

Asterpy.utils.ierバッグ

クラス

Conf \()	の構成パラメータ astropy.utils.iers それがそうです。
IERS \([data, masked, names, dtype, meta, ...] )	汎型IERS表クラスは，補間関数を定義する.
IERSRangeError \	日付がIERSの有効範囲を超えた場合のどのようなエラーも
IERSStaleWarning \
IERS_A \([data, masked, names, dtype, meta, ...] )	IERS AをターゲットとしたIERS表クラスは，USNOが提供する。
IERS_Auto \([data, masked, names, dtype, ...] )	最新のIERSデータを提供し，必要に応じて更新値のダウンロードを自動処理する.
IERS_B \([data, masked, names, dtype, meta, ...] )	IERS Bに対するIERS表クラスは，IERS自身が提供する.
LeapSeconds \([data, masked, names, dtype, ...] )	秒級、TAI-UTC差を把握する。
earth_orientation_table \()	地球自転と参考系サービスのデフォルトIERS表。

Asterpy.utils.リフレクションモジュール

Python実行時のリフレクションに関する関数です。

機能

resolve_name \(名前，*その他_部品)	解析は以下のような名称である module.object 1つのオブジェクトにバインドし，それを返す.
minversion \(モジュール，バージョン[, inclusive, ...] )	返品 True 指定されたPythonモジュールが最低バージョンの要件を満たしている場合、 False もしそうでなければ。
find_current_module \([depth, finddiff] )	その中からこの関数を呼び出すモジュール/パケットを決定する.
isinstancemethod (cls，obj)	返品 True 所与のオブジェクトがそれを定義するクラスのインスタンスメソッドである場合(および staticmethod あるいはそうだ classmethod ）。

Asterpy.utils.Metadataモジュール

このモジュールは，メタデータを処理するためのブースタ関数とクラスを含む.

機能

common_dtype (ARRS)	Numpyを使用してndarrayリストの汎用データタイプを検索します。
enable_merge_strategies \(*マージ_ポリシー)	コンテキストマネージャは、1つまたは複数のカスタムメタデータ統合ポリシーを一時的に有効にする。
merge \(左，右[, merge_func, ...] )	合併する. left そして right メタデータオブジェクト。

クラス

MergeConflictError \
MergeConflictWarning \
MergePlus \()	合併する. left そして right オブジェクトには加号演算子を用いる.
MergeNpConcatenate \()	合併する. left そして right Np.comatenateのオブジェクトを用いる.
MergeStrategy \()	左および右の2つのソースからのメタデータを単一の出力に統合するポリシーを定義するための基本クラスを定義する。
MergeStrategyMeta \(名前，拠点，メンバー)	MergeStrategyサブクラスをMerge_Strategyレジストリのメタクラスに登録する.
MetaData \([doc, copy] )	クラスの記述子、これらのクラスは meta 財産です。
MetaAttribute \([default] )	オブジェクトに格納されたカスタム属性を定義するための記述子 meta Dictは、定義されたデフォルト値を有することができる。

Asterpy.utils.miscモジュール

比較的小さい汎用ユーティリティからなる“グリップパッケージ”であって、明確なモジュール/パケットを使用することができない“パッケージ”。

機能

isiterable \(OBJ)	返品 True 所与のオブジェクトが反復可能である場合。
silence \()	Sys.stdoutとsys.stderrを暗黙にするコンテキストマネージャ。
format_exception \(メッセージ，*args, * *kwargs)	Given an exception message string, uses new-style formatting arguments {filename}, {lineno}, {func} and/or {text} to fill in information about the exception that occurred.
find_api_page \(OBJ[, version, openinbrowser, ...] )	指定対象のAPIページのURLを決定し，Webブラウザでそのページを開くことを選択する.
is_path_hidden \(ファイルパス)	所与のファイルまたはディレクトリが隠れているかどうかを判断します。
walk_skip_hidden \(上)[, onerror, followlinks] )	包装用の包装 os.walk 隠れたファイルやディレクトリをスキップする。
indent \(s[, shift, width] )	テキストを1つインデントする.
dtype_bytes_or_chars \(dtype)	Dtype.str値から“<u 5”や“<f 8”のような数字を解析する.

クラス

NumpyRNGContext \(シード)	コンテキストマネージャ(と with 文)は，デジタル乱数生成器(RNG)を特定の値に設定し，RNG状態を以前の状態に戻す.
JsonCustomEncoder \(\*[, skipkeys, ...] )	JSONデフォルトエンコーダでサポートされていないデータ·タイプをサポートします。
OrderedDescriptor \(*args, * *kwargs)	バージョン 4.3 で非推奨.
OrderedDescriptorContainer (CLS_NAME，BASES，...)	バージョン 4.3 で非推奨.

Asterpy.utils.Parsingモジュール

舗装用包装物であって、ねじ安全性を提供する。

機能

lex (lextab，パッケージ[, reflags] )	局所変数から字句解析器を作成する.
yacc (Tabモジュール，パッケージ)	ローカル変数からパーサを作成する.

クラス

ThreadSafeParser \(パーサ)

パッケージは生成された解析器によって ply.yacc.yacc それがそうです。

Asterpy.utils.Stateモジュール

世界の科学状態を管理する簡単な種類です参照してください 新しい構成項目の追加 もっと細かいことを知っています。

クラス

ScienceState \()

科学状態サブクラスは，科学結果に影響を与える可能性のあるグローバルプロジェクトを管理するために用いられる.

Asterpy.utils.Sharesモジュール

ShapedLikeNDArrayは，入力クラスと形状に関する関数を混合する.

機能

check_broadcast \(*形状)	互いにブロードキャスト可能かどうかは、2つ以上のNumpy配列の形状タプルのみから決定される。
unbroadcast \(配列)	配列が与えられると、元の配列の最小サブセットである新しい配列が戻り、元の配列に再ブロードキャストすることができる。

クラス

NDArrayShapeMethods \()	Mixinクラスは形状変更方法を提供する.
ShapedLikeNDArray \()	Mixinクラスは形状変更方法を提供する.
IncompatibleShapeError \(形状_a，形状_a_idx，...)

ファイルダウンロード

Asterpy.utils.Dataモジュール

データファイルにアクセス、ダウンロード、およびキャッシュするための機能。

機能

download_file \(リモート_url[, cache, ...] )	URLをダウンロードし、キャッシュ結果を選択することができます。
download_files_in_parallel \(URL[, cache, ...] )	与えられたURLから複数のファイルを並列にダウンロードする.
get_readable_fileobj \(名前_または_obj[, ...] )	ファイルまたはURLから読み取り可能で検索可能な類似ファイルのオブジェクトを生成する。
get_pkg_data_fileobj \(データ_名前[, package, ...] )	パケットの標準位置からデータファイルを検索し，そのファイルを読み出しバイトのクラスファイルオブジェクトとして提供する.
get_pkg_data_filename \(データ_名前[, package, ...] )	パケットの標準位置からデータファイルを検索し、データのローカルファイル名を提供する。
get_pkg_data_contents \(データ_名前[, package, ...] )	標準位置からデータファイルを検索し，その内容をBytesオブジェクトとして返す.
get_pkg_data_fileobjs \(データディレクトリ[, package, ...] )	所与のディレクトリ内の所与のGLOBパターンに一致するすべてのデータファイルの可読ファイルオブジェクトを返します。
get_pkg_data_filenames \(データディレクトリ[, package, ...] )	所与のグローバル·パターンに一致する所与のディレクトリ内のすべてのデータファイルのパスを返します。
get_pkg_data_path \(*パス[, package] )	ソースを含むデータディレクトリから経路を取得する.
is_url \(文字列)	文字列が有効なURLであるかどうかをテストする download_file() それがそうです。
is_url_in_cache \(URL_Key[, pkgname] )	ダウンロードしたかどうかチェックします url_key キャッシュにあります。
get_cached_urls \([pkgname] )	キャッシュ中のURLリストを取得する.
cache_total_size \([pkgname] )	キャッシュ中のすべてのファイルの総サイズ(バイト単位)を返す.
cache_contents \([pkgname] )	キャッシュのURLをファイル名にマッピングしたDICTを取得する.
export_download_cache \(ファイル名_または_obj[, ...] )	キャッシュ内容をZIPファイルとして導出する.
import_download_cache \(ファイル名_または_obj[, ...] )	ZIPファイルの内容をキャッシュに導入する.
import_file_to_cache (URL_Key，ファイル名[, ...] )	FileNameで指定されたディスクファイルをキャッシュに導入します。
check_download_cache \([check_hashes, pkgname] )	キャッシュに対して一貫性チェックを実行する.
clear_download_cache \([hashorurl, pkgname] )	ローカル·ファイルを削除することでデータファイル·キャッシュを消去します。
compute_hash (localfn)	ファイルのMD 5ハッシュを計算する.
get_free_space_in_dir \(パス[, unit] )	ディレクトリパスが与えられた場合、ファイルシステム上の利用可能な空間量が返される。
check_free_space_in_dir \(パス，サイズ)	所与のディレクトリが所与のサイズのファイルを格納するのに十分な空間があるかどうかを決定する。
get_file_contents \(*args, * *kwargs)	ファイル名や類似ファイルのオブジェクトの内容を検索する.

クラス

Conf \()	の構成パラメータ astropy.utils.data それがそうです。
CacheMissingWarning \	この警告は、標準キャッシュディレクトリがアクセスできないことを示し、第1のパラメータは警告メッセージを提供する。
CacheDamaged \(*パラメータ[, bad_urls, bad_files] )	問題となったURLやファイルを記録する.

XML

♪the astropy.utils.xml.* モジュールは様々なものを提供します XML 工具を加工する。

Asterpy.utils.xml.checkモジュール

XMLに関する様々な文字列が標準的な関数集合に適合しているかどうかを検査するために用いられる.

機能

check_anyuri \(URI)	返品 True もし uri RFC 2396に定義されている有効なURIです。
check_id \(ID)	返品 True もし ID 有効なXML IDである.
check_mime_content_type \(コンテンツ_タイプ)	返品 True もし content_type RFC 2045によって定義されるように、有効なMIMEコンテンツタイプである(少なくとも文法的に)。
check_token \(トークン)	返品 True もし トークン. 有効なXMLトークンであり，XML Schema第2部で定義されている.
fix_id \(ID)	任意の文字列が与えられた場合、XMLIDとして使用可能な文字列を作成する。

Asterpy.utils.xml.iterparserモジュール

このモジュールは、反復器ベースの高速XMLパーサを含む。

機能

get_xml_iterator \(ソース[, ...] )	XML文書要素の反復器を返す.
get_xml_encoding \(ソース)	XML文書のヘッダを読み込むことでそのコードを決定する.
xml_readlines \(ソース)	与えられたXML文書から行を取得する.

Asterpy.utils.xmlデコーダモジュール

URLは変換関数をキャンセルする.

機能

unescape_all \(URL)

与えられたURLを再帰的に変換する.

Asterpy.utils.xml.Validationモジュール

XMLモデルとDTD検証を行う関数.現在，これはxmllintに1つの子プロセス呼び出しを発行している.適切なライブラリを見つけることができれば、将来的にPythonベースのライブラリを使用することができます。

機能

validate_schema \(ファイル名、アーキテクチャ_ファイル)

アーキテクチャやDTDによりXML文書を検証する.

Asterpy.utils.xml.Writerモジュール

流出フォーマットが良好でインデントの良いXMLを簡単にするクラスを含む。

クラス

XMLWriter \(ファイル)

作成フォーマットが良好でインデントの良いXMLのクラスである.