開発ツール¶
この章で紹介されるモジュールはソフトウェアを書くことを支援します。たとえば、 pydoc
モジュールはモジュールの内容からドキュメントを生成します。 doctest
と unittest
モジュールでは、自動的に実行して予想通りの出力が生成されるか確認するユニットテストを書くことができます。
この章で解説されるモジュールのリスト:
typing
--- 型ヒントのサポート- Python 型システムの仕様
- 型エイリアス
- NewType
- 呼び出し可能オブジェクトのアノテーション
- ジェネリクス
- タプルのアノテーション
- クラスオブジェクトの型
- Annotating generators and coroutines
- ユーザー定義のジェネリック型
Any
型- 名前的部分型 vs 構造的部分型
- モジュールの内容
- 特殊型付けプリミティブ
- プロトコル
- ABCs for working with IO
- Functions and decorators
- Introspection helpers
- 定数
- 非推奨のエイリアス
- メジャーな機能の非推奨時系列
pydoc
--- ドキュメント生成とオンラインヘルプシステム- Python 開発モード
doctest
--- 対話型の Python の例をテストする- 簡単な利用法: docstring 中の実行例をチェックする
- 簡単な利用法: テキストファイル中の実行例をチェックする
- doctest のからくり
- 基本 API
- 単体テスト API
- 拡張 API
- デバッグ
- アドバイス
unittest
--- ユニットテストフレームワーク- 基本的な例
- コマンドラインインターフェイス
- テストディスカバリ
- テストコードの構成
- 既存テストコードの再利用
- テストのスキップと予期された失敗
- サブテストを利用して繰り返しテストの区別を付ける
- クラスと関数
- テストクラス
TestCase
setUp()
tearDown()
setUpClass()
tearDownClass()
run()
skipTest()
subTest()
debug()
assertEqual()
assertNotEqual()
assertTrue()
assertFalse()
assertIs()
assertIsNot()
assertIsNone()
assertIsNotNone()
assertIn()
assertNotIn()
assertIsInstance()
assertNotIsInstance()
assertRaises()
assertRaisesRegex()
assertWarns()
assertWarnsRegex()
assertLogs()
assertNoLogs()
assertAlmostEqual()
assertNotAlmostEqual()
assertGreater()
assertGreaterEqual()
assertLess()
assertLessEqual()
assertRegex()
assertNotRegex()
assertCountEqual()
addTypeEqualityFunc()
assertMultiLineEqual()
assertSequenceEqual()
assertListEqual()
assertTupleEqual()
assertSetEqual()
assertDictEqual()
fail()
failureException
longMessage
maxDiff
countTestCases()
defaultTestResult()
id()
shortDescription()
addCleanup()
enterContext()
doCleanups()
addClassCleanup()
enterClassContext()
doClassCleanups()
IsolatedAsyncioTestCase
FunctionTestCase
- テストのグループ化
- テストのロードと起動
TestLoader
TestResult
errors
failures
skipped
expectedFailures
unexpectedSuccesses
collectedDurations
shouldStop
testsRun
buffer
failfast
tb_locals
wasSuccessful()
stop()
startTest()
stopTest()
startTestRun()
stopTestRun()
addError()
addFailure()
addSuccess()
addSkip()
addExpectedFailure()
addUnexpectedSuccess()
addSubTest()
addDuration()
TextTestResult
defaultTestLoader
TextTestRunner
main()
- load_tests プロトコル
- テストクラス
- クラスとモジュールのフィクスチャ
- シグナルハンドリング
unittest.mock
--- モックオブジェクトライブラリ- クイックガイド
- Mock クラス
Mock
assert_called()
assert_called_once()
assert_called_with()
assert_called_once_with()
assert_any_call()
assert_has_calls()
assert_not_called()
reset_mock()
mock_add_spec()
attach_mock()
configure_mock()
__dir__()
_get_child_mock()
called
call_count
return_value
side_effect
call_args
call_args_list
method_calls
mock_calls
__class__
NonCallableMock
PropertyMock
AsyncMock
ThreadingMock
- 呼び出し
- 属性の削除
- Mock の名前と name 属性
- 属性として設定されるモック
- patcher
- MagicMock と magic method のサポート
- ヘルパー
- Order of precedence of
side_effect
,return_value
and wraps
unittest.mock
--- 入門test
--- Regression tests package for Pythontest.support
--- テストのためのユーティリティ関数TestFailed
ResourceDenied
verbose
is_jython
is_android
unix_shell
LOOPBACK_TIMEOUT
INTERNET_TIMEOUT
SHORT_TIMEOUT
LONG_TIMEOUT
PGO
PIPE_MAX_SIZE
Py_DEBUG
SOCK_MAX_SIZE
TEST_SUPPORT_DIR
TEST_HOME_DIR
TEST_DATA_DIR
MAX_Py_ssize_t
max_memuse
real_max_memuse
MISSING_C_DOCSTRINGS
HAVE_DOCSTRINGS
TEST_HTTP_URL
ALWAYS_EQ
NEVER_EQ
LARGEST
SMALLEST
busy_retry()
sleeping_retry()
is_resource_enabled()
python_is_optimized()
with_pymalloc()
requires()
sortdict()
findfile()
get_pagesize()
setswitchinterval()
check_impl_detail()
set_memlimit()
record_original_stdout()
get_original_stdout()
args_from_interpreter_flags()
optim_args_from_interpreter_flags()
captured_stdin()
captured_stdout()
captured_stderr()
disable_faulthandler()
gc_collect()
disable_gc()
swap_attr()
swap_item()
flush_std_streams()
print_warning()
wait_process()
calcobjsize()
calcvobjsize()
checksizeof()
anticipate_failure()
system_must_validate_cert()
run_with_locale()
run_with_tz()
requires_freebsd_version()
requires_linux_version()
requires_mac_version()
requires_gil_enabled()
requires_IEEE_754()
requires_zlib()
requires_gzip()
requires_bz2()
requires_lzma()
requires_resource()
requires_docstrings()
requires_limited_api()
cpython_only()
impl_detail()
no_tracing()
refcount_test()
bigmemtest()
bigaddrspacetest()
check_syntax_error()
open_urlresource()
reap_children()
get_attribute()
catch_unraisable_exception()
load_package_tests()
detect_api_mismatch()
patch()
run_in_subinterp()
check_free_after_iterating()
missing_compiler_executable()
check__all__()
skip_if_broken_multiprocessing_synchronize()
check_disallow_instantiation()
adjust_int_max_str_digits()
SuppressCrashReport
SaveSignals
Matcher
test.support.socket_helper
--- Utilities for socket teststest.support.script_helper
--- Utilities for the Python execution teststest.support.bytecode_helper
--- Support tools for testing correct bytecode generationtest.support.threading_helper
--- Utilities for threading teststest.support.os_helper
--- Utilities for os testsFS_NONASCII
SAVEDCWD
TESTFN
TESTFN_NONASCII
TESTFN_UNENCODABLE
TESTFN_UNDECODABLE
TESTFN_UNICODE
EnvironmentVarGuard
FakePath
set()
unset()
can_symlink()
can_xattr()
change_cwd()
create_empty_file()
fd_count()
fs_is_case_insensitive()
make_bad_fd()
rmdir()
rmtree()
skip_unless_symlink()
skip_unless_xattr()
temp_cwd()
temp_dir()
temp_umask()
unlink()
test.support.import_helper
--- Utilities for import teststest.support.warnings_helper
--- Utilities for warnings tests