_testcapi - pydoc - phpman

Help on module _testcapi:

NAME
    _testcapi

MODULE REFERENCE
    https://docs.python.org/3.10/library/_testcapi.html

    The following documentation is automatically generated from the Python
    source files.  It may be incomplete, incorrect or include features that
    are considered implementation detail and may vary between Python
    implementations.  When in doubt, consult the module reference at the
    location listed above.

CLASSES
    HeapCType(builtins.object)
        HeapCTypeSubclass
            HeapCTypeSubclassWithFinalizer
    builtins.Exception(builtins.BaseException)
        error
    builtins.object
        ContainerNoGC
        HeapCTypeSetattr
        HeapCTypeWithBuffer
        HeapCTypeWithDict
        HeapCTypeWithNegativeDict
        HeapCTypeWithWeakref
        HeapDocCType
        HeapGcCType
        NullTpDocType

    class ContainerNoGC(builtins.object)
     |  Static methods defined here:
     |
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |
     |  value
     |      a container value for test purposes

    class HeapCTypeSetattr(builtins.object)
     |  A heap type without GC, but with overridden __setattr__.
     |
     |  The 'value' attribute is set to 10 in __init__ and updated via attribute setting.
     |
     |  Methods defined here:
     |
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |
     |  __init__(self, /, *args, **kwargs)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |
     |  pvalue

    class HeapCTypeSubclass(HeapCType)
     |  Subclass of HeapCType, without GC.
     |
     |  __init__ sets the 'value' attribute to 10 and 'value2' to 20.
     |
     |  Method resolution order:
     |      HeapCTypeSubclass
     |      HeapCType
     |      builtins.object
     |
     |  Methods defined here:
     |
     |  __init__(self, /, *args, **kwargs)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |
     |  value2
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from HeapCType:
     |
     |  value

    class HeapCTypeSubclassWithFinalizer(HeapCTypeSubclass)
     |  Subclass of HeapCType with a finalizer that reassigns __class__.
     |
     |  __class__ is set to plain HeapCTypeSubclass during finalization.
     |  __init__ sets the 'value' attribute to 10 and 'value2' to 20.
     |
     |  Method resolution order:
     |      HeapCTypeSubclassWithFinalizer
     |      HeapCTypeSubclass
     |      HeapCType
     |      builtins.object
     |
     |  Methods defined here:
     |
     |  __del__(...)
     |
     |  __init__(self, /, *args, **kwargs)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |
     |  value2
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from HeapCType:
     |
     |  value

    class HeapCTypeWithBuffer(builtins.object)
     |  Heap type with buffer support.
     |
     |  The buffer is set to [b'1', b'2', b'3', b'4']

    class HeapCTypeWithDict(builtins.object)
     |  Data descriptors defined here:
     |
     |  __dict__
     |
     |  dictobj

    class HeapCTypeWithNegativeDict(builtins.object)
     |  Data descriptors defined here:
     |
     |  __dict__
     |
     |  dictobj

    class HeapCTypeWithWeakref(builtins.object)
     |  Data descriptors defined here:
     |
     |  weakreflist

    class HeapDocCType(builtins.object)
     |  HeapDocCType(arg1, arg2)
     |
     |  somedoc

    class HeapGcCType(builtins.object)
     |  A heap type with GC, and with overridden dealloc.
     |
     |  The 'value' attribute is set to 10 in __init__.
     |
     |  Methods defined here:
     |
     |  __init__(self, /, *args, **kwargs)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |
     |  value

    class NullTpDocType(builtins.object)

    class error(builtins.Exception)
     |  Method resolution order:
     |      error
     |      builtins.Exception
     |      builtins.BaseException
     |      builtins.object
     |
     |  Data descriptors defined here:
     |
     |  __weakref__
     |      list of weak references to the object (if defined)
     |
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.Exception:
     |
     |  __init__(self, /, *args, **kwargs)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |
     |  ----------------------------------------------------------------------
     |  Static methods inherited from builtins.Exception:
     |
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.BaseException:
     |
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |
     |  __reduce__(...)
     |      Helper for pickle.
     |
     |  __repr__(self, /)
     |      Return repr(self).
     |
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |
     |  __setstate__(...)
     |
     |  __str__(self, /)
     |      Return str(self).
     |
     |  with_traceback(...)
     |      Exception.with_traceback(tb) --
     |      set self.__traceback__ to tb and return self.
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from builtins.BaseException:
     |
     |  __cause__
     |      exception cause
     |
     |  __context__
     |      exception context
     |
     |  __dict__
     |
     |  __suppress_context__
     |
     |  __traceback__
     |
     |  args

FUNCTIONS
    DecodeLocaleEx(...)

    EncodeLocaleEx(...)

    PyBuffer_SizeFromFormat(...)

    PyDateTime_DATE_GET(...)

    PyDateTime_DELTA_GET(...)

    PyDateTime_GET(...)

    PyDateTime_TIME_GET(...)

    PyTime_AsMicroseconds(...)

    PyTime_AsMilliseconds(...)

    PyTime_AsSecondsDouble(...)

    PyTime_AsTimespec(...)

    PyTime_AsTimeval(...)

    PyTime_FromSeconds(...)

    PyTime_FromSecondsObject(...)

    Py_CompileString(...)

    W_STOPCODE(...)

    argparsing(...)

    bad_get(...)

    call_in_temporary_c_thread(...)
        set_error_class(error_class) -> None

    check_pyobject_forbidden_bytes_is_freed(...)

    check_pyobject_freed_is_freed(...)

    check_pyobject_null_is_freed(...)

    check_pyobject_uninitialized_is_freed(...)

    code_newempty(...)

    codec_incrementaldecoder(...)

    codec_incrementalencoder(...)

    crash_no_current_thread(...)

    create_cfunction(...)

    datetime_check_date(...)

    datetime_check_datetime(...)

    datetime_check_delta(...)

    datetime_check_time(...)

    datetime_check_tzinfo(...)

    dict_get_version(...)

    dict_getitem_knownhash(...)

    dict_hassplittable(...)

    docstring_empty(...)

    docstring_no_signature(...)
        This docstring has no signature.

    docstring_with_invalid_signature(...)
        docstring_with_invalid_signature($module, /, boo)

        This docstring has an invalid signature.

    docstring_with_invalid_signature2(...)
        docstring_with_invalid_signature2($module, /, boo)

        --

        This docstring also has an invalid signature.

    docstring_with_signature(sig)
        This docstring has a valid signature.

    docstring_with_signature_and_extra_newlines(parameter)
        This docstring has a valid signature and some extra newlines.

    docstring_with_signature_but_no_doc(sig)

    docstring_with_signature_with_defaults(module, s='avocado', b=b'bytes', d=3.14, i=35, n=None, t=True, f=False, local=3, sys=9223372036854775807, exp=9223372036854775806)
        This docstring has a valid signature with parameters,
        and the parameters take defaults of varying types.

    exception_print(...)

    fatal_error(...)
        fatal_error(message, release_gil=False): call Py_FatalError(message)

    get_args(...)

    get_date_fromdate(...)

    get_date_fromtimestamp(...)

    get_datetime_fromdateandtime(...)

    get_datetime_fromdateandtimeandfold(...)

    get_datetime_fromtimestamp(...)

    get_delta_fromdsu(...)

    get_kwargs(...)

    get_mapping_items(...)

    get_mapping_keys(...)

    get_mapping_values(...)

    get_time_fromtime(...)

    get_time_fromtimeandfold(...)

    get_timezone_utc_capi(...)

    get_timezones_offset_zero(...)

    getargs_B(...)

    getargs_C(...)

    getargs_D(...)

    getargs_H(...)

    getargs_I(...)

    getargs_K(...)

    getargs_L(...)

    getargs_S(...)

    getargs_U(...)

    getargs_Y(...)

    getargs_Z(...)

    getargs_Z_hash(...)

    getargs_b(...)

    getargs_c(...)

    getargs_d(...)

    getargs_es(...)

    getargs_es_hash(...)

    getargs_et(...)

    getargs_et_hash(...)

    getargs_f(...)

    getargs_h(...)

    getargs_i(...)

    getargs_k(...)

    getargs_keyword_only(...)

    getargs_keywords(...)

    getargs_l(...)

    getargs_n(...)

    getargs_p(...)

    getargs_positional_only_and_keywords(...)

    getargs_s(...)

    getargs_s_hash(...)

    getargs_s_hash_int(...)

    getargs_s_hash_int2(...)

    getargs_s_star(...)

    getargs_tuple(...)

    getargs_u(...)

    getargs_u_hash(...)

    getargs_w_star(...)

    getargs_y(...)

    getargs_y_hash(...)

    getargs_y_star(...)

    getargs_z(...)

    getargs_z_hash(...)

    getargs_z_star(...)

    getbuffer_with_null_view(...)

    getitem_with_error(...)

    gh_99240_clear_args(...)

    hamt(...)

    join_temporary_c_thread(...)

    make_exception_with_doc(...)

    make_memoryview_from_NULL_pointer(...)

    make_timezones_capi(...)

    mapping_has_key(...)

    meth_fastcall(...)

    meth_fastcall_keywords(...)

    meth_noargs(...)

    meth_o(...)

    meth_varargs(...)

    meth_varargs_keywords(...)

    no_docstring(...)

    parse_tuple_and_keywords(...)

    pymarshal_read_last_object_from_file(...)

    pymarshal_read_long_from_file(...)

    pymarshal_read_object_from_file(...)

    pymarshal_read_short_from_file(...)

    pymarshal_write_long_to_file(...)

    pymarshal_write_object_to_file(...)

    pymem_api_misuse(...)

    pymem_buffer_overflow(...)

    pymem_getallocatorsname(...)

    pymem_malloc_without_gil(...)

    pynumber_tobase(...)

    pyobject_bytes_from_null(...)

    pyobject_fastcall(...)

    pyobject_fastcalldict(...)

    pyobject_malloc_without_gil(...)

    pyobject_repr_from_null(...)

    pyobject_str_from_null(...)

    pyobject_vectorcall(...)

    pytime_object_to_time_t(...)

    pytime_object_to_timespec(...)

    pytime_object_to_timeval(...)

    pyvectorcall_call(...)

    raise_SIGINT_then_send_None(...)

    raise_exception(...)

    raise_memoryerror(...)

    remove_mem_hooks(...)
        Remove memory hooks.

    return_null_without_error(...)

    return_result_with_error(...)

    run_in_subinterp(...)

    sequence_getitem(...)

    sequence_setitem(...)

    set_errno(...)

    set_exc_info(...)

    set_nomemory(...)
        set_nomemory(start:int, stop:int = 0)

    stack_pointer(...)

    test_L_code(...)

    test_Z_code(...)

    test_buildvalue_N(...)

    test_buildvalue_issue38913(...)

    test_capsule(...)

    test_config(...)

    test_datetime_capi(...)

    test_decref_doesnt_leak(...)

    test_dict_iteration(...)

    test_empty_argparse(...)

    test_from_contiguous(...)

    test_gc_control(...)

    test_get_statictype_slots(...)

    test_incref_decref_API(...)

    test_incref_doesnt_leak(...)

    test_k_code(...)

    test_lazy_hash_inheritance(...)

    test_list_api(...)

    test_long_and_overflow(...)

    test_long_api(...)

    test_long_as_double(...)

    test_long_as_size_t(...)

    test_long_as_unsigned_long_long_mask(...)

    test_long_long_and_overflow(...)

    test_long_numbits(...)

    test_longlong_api(...)

    test_mapping_has_key_string(...)

    test_pep3118_obsolete_write_locks(...)

    test_py_is_funcs(...)

    test_py_is_macros(...)

    test_pymem_alloc0(...)

    test_pymem_setallocators(...)

    test_pymem_setrawallocators(...)

    test_pyobject_setallocators(...)

    test_pythread_tss_key_state(...)

    test_refcount_funcs(...)

    test_refcount_macros(...)

    test_s_code(...)

    test_set_type_size(...)

    test_sizeof_c_types(...)

    test_string_from_format(...)

    test_string_to_double(...)

    test_structseq_newtype_doesnt_leak(...)

    test_structseq_newtype_null_descr_doc(...)

    test_u_code(...)

    test_unicode_compare_with_ascii(...)

    test_widechar(...)

    test_with_docstring(...)
        This is a pretty normal docstring.

    test_xdecref_doesnt_leak(...)

    test_xincref_doesnt_leak(...)

    traceback_print(...)

    tracemalloc_get_traceback(...)

    tracemalloc_track(...)

    tracemalloc_untrack(...)

    unicode_asucs4(...)

    unicode_asutf8(...)

    unicode_asutf8andsize(...)

    unicode_aswidechar(...)

    unicode_aswidecharstring(...)

    unicode_copycharacters(...)

    unicode_encodedecimal(...)

    unicode_findchar(...)

    unicode_legacy_string(...)

    unicode_transformdecimaltoascii(...)

    with_tp_del(...)

    without_gc(...)

    write_unraisable_exc(...)

DATA
    CHAR_MAX = 127
    CHAR_MIN = -128
    DBL_MAX = 1.7976931348623157e+308
    DBL_MIN = 2.2250738585072014e-308
    FLT_MAX = 3.4028234663852886e+38
    FLT_MIN = 1.1754943508222875e-38
    INT_MAX = 2147483647
    INT_MIN = -2147483648
    LLONG_MAX = 9223372036854775807
    LLONG_MIN = -9223372036854775808
    LONG_MAX = 9223372036854775807
    LONG_MIN = -9223372036854775808
    PY_SSIZE_T_MAX = 9223372036854775807
    PY_SSIZE_T_MIN = -9223372036854775808
    SHRT_MAX = 32767
    SHRT_MIN = -32768
    SIZEOF_TIME_T = 8
    UCHAR_MAX = 255
    UINT_MAX = 4294967295
    ULLONG_MAX = 18446744073709551615
    ULONG_MAX = 18446744073709551615
    USHRT_MAX = 65535
    WITH_PYMALLOC = True
    the_number_three = 3

FILE
    /usr/lib/python3.10/lib-dynload/_testcapi.cpython-310-x86_64-linux-gnu.so