Concrete Objects Layer

The functions in this chapter are specific to certain Python object types. Passing them an object of the wrong type is not a good idea; if you receive an object from a Python program and you are not sure that it has the right type, you must perform a type check first; for example, to check that an object is a dictionary, use PyDict_Check(). The chapter is structured like the “family tree” of Python object types.

Warning

While the functions described in this chapter carefully check the type of the objects which are passed in, many of them do not check for NULL being passed instead of a valid object. Allowing NULL to be passed in can cause memory access violations and immediate termination of the interpreter.

Fundamental Objects

This section describes Python type objects and the singleton object None.

• Type Objects
  • PyTypeObject
  • PyType_Type
  • PyType_Check()
  • PyType_CheckExact()
  • PyType_ClearCache()
  • PyType_GetFlags()
  • PyType_Modified()
  • PyType_HasFeature()
  • PyType_IS_GC()
  • PyType_IsSubtype()
  • PyType_GenericAlloc()
  • PyType_GenericNew()
  • PyType_Ready()
  • PyType_GetSlot()
  • PyType_GetModule()
  • PyType_GetModuleState()
  • Creating Heap-Allocated Types
    • PyType_FromModuleAndSpec()
    • PyType_FromSpecWithBases()
    • PyType_FromSpec()
    • PyType_Spec
      • name
      • basicsize
      • itemsize
      • flags
      • slots
    • PyType_Slot
      • slot
      • pfunc
• The None Object
  • Py_None
  • Py_RETURN_NONE

Numeric Objects

• Integer Objects
  • PyLongObject
  • PyLong_Type
  • PyLong_Check()
  • PyLong_CheckExact()
  • PyLong_FromLong()
  • PyLong_FromUnsignedLong()
  • PyLong_FromSsize_t()
  • PyLong_FromSize_t()
  • PyLong_FromLongLong()
  • PyLong_FromUnsignedLongLong()
  • PyLong_FromDouble()
  • PyLong_FromString()
  • PyLong_FromUnicodeObject()
  • PyLong_FromVoidPtr()
  • PyLong_AsLong()
  • PyLong_AsLongAndOverflow()
  • PyLong_AsLongLong()
  • PyLong_AsLongLongAndOverflow()
  • PyLong_AsSsize_t()
  • PyLong_AsUnsignedLong()
  • PyLong_AsSize_t()
  • PyLong_AsUnsignedLongLong()
  • PyLong_AsUnsignedLongMask()
  • PyLong_AsUnsignedLongLongMask()
  • PyLong_AsDouble()
  • PyLong_AsVoidPtr()
• Boolean Objects
  • PyBool_Check()
  • Py_False
  • Py_True
  • Py_RETURN_FALSE
  • Py_RETURN_TRUE
  • PyBool_FromLong()
• Floating Point Objects
  • PyFloatObject
  • PyFloat_Type
  • PyFloat_Check()
  • PyFloat_CheckExact()
  • PyFloat_FromString()
  • PyFloat_FromDouble()
  • PyFloat_AsDouble()
  • PyFloat_AS_DOUBLE()
  • PyFloat_GetInfo()
  • PyFloat_GetMax()
  • PyFloat_GetMin()
• Complex Number Objects
  • Complex Numbers as C Structures
    • Py_complex
    • _Py_c_sum()
    • _Py_c_diff()
    • _Py_c_neg()
    • _Py_c_prod()
    • _Py_c_quot()
    • _Py_c_pow()
  • Complex Numbers as Python Objects
    • PyComplexObject
    • PyComplex_Type
    • PyComplex_Check()
    • PyComplex_CheckExact()
    • PyComplex_FromCComplex()
    • PyComplex_FromDoubles()
    • PyComplex_RealAsDouble()
    • PyComplex_ImagAsDouble()
    • PyComplex_AsCComplex()

Sequence Objects

Generic operations on sequence objects were discussed in the previous chapter; this section deals with the specific kinds of sequence objects that are intrinsic to the Python language.

• Bytes Objects
  • PyBytesObject
  • PyBytes_Type
  • PyBytes_Check()
  • PyBytes_CheckExact()
  • PyBytes_FromString()
  • PyBytes_FromStringAndSize()
  • PyBytes_FromFormat()
  • PyBytes_FromFormatV()
  • PyBytes_FromObject()
  • PyBytes_Size()
  • PyBytes_GET_SIZE()
  • PyBytes_AsString()
  • PyBytes_AS_STRING()
  • PyBytes_AsStringAndSize()
  • PyBytes_Concat()
  • PyBytes_ConcatAndDel()
  • _PyBytes_Resize()
• Byte Array Objects
  • PyByteArrayObject
  • PyByteArray_Type
  • Type check macros
    • PyByteArray_Check()
    • PyByteArray_CheckExact()
  • Direct API functions
    • PyByteArray_FromObject()
    • PyByteArray_FromStringAndSize()
    • PyByteArray_Concat()
    • PyByteArray_Size()
    • PyByteArray_AsString()
    • PyByteArray_Resize()
  • Macros
    • PyByteArray_AS_STRING()
    • PyByteArray_GET_SIZE()
• Unicode Objects and Codecs
  • Unicode Objects
    • Unicode Type
      • Py_UCS4
      • Py_UCS2
      • Py_UCS1
      • Py_UNICODE
      • PyASCIIObject
      • PyCompactUnicodeObject
      • PyUnicodeObject
      • PyUnicode_Type
      • PyUnicode_Check()
      • PyUnicode_CheckExact()
      • PyUnicode_READY()
      • PyUnicode_GET_LENGTH()
      • PyUnicode_1BYTE_DATA()
      • PyUnicode_2BYTE_DATA()
      • PyUnicode_4BYTE_DATA()
      • PyUnicode_WCHAR_KIND
      • PyUnicode_1BYTE_KIND
      • PyUnicode_2BYTE_KIND
      • PyUnicode_4BYTE_KIND
      • PyUnicode_KIND()
      • PyUnicode_DATA()
      • PyUnicode_WRITE()
      • PyUnicode_READ()
      • PyUnicode_READ_CHAR()
      • PyUnicode_MAX_CHAR_VALUE()
      • PyUnicode_GET_SIZE()
      • PyUnicode_GET_DATA_SIZE()
      • PyUnicode_AS_UNICODE()
      • PyUnicode_AS_DATA()
      • PyUnicode_IsIdentifier()
    • Unicode Character Properties
      • Py_UNICODE_ISSPACE()
      • Py_UNICODE_ISLOWER()
      • Py_UNICODE_ISUPPER()
      • Py_UNICODE_ISTITLE()
      • Py_UNICODE_ISLINEBREAK()
      • Py_UNICODE_ISDECIMAL()
      • Py_UNICODE_ISDIGIT()
      • Py_UNICODE_ISNUMERIC()
      • Py_UNICODE_ISALPHA()
      • Py_UNICODE_ISALNUM()
      • Py_UNICODE_ISPRINTABLE()
      • Py_UNICODE_TOLOWER()
      • Py_UNICODE_TOUPPER()
      • Py_UNICODE_TOTITLE()
      • Py_UNICODE_TODECIMAL()
      • Py_UNICODE_TODIGIT()
      • Py_UNICODE_TONUMERIC()
      • Py_UNICODE_IS_SURROGATE()
      • Py_UNICODE_IS_HIGH_SURROGATE()
      • Py_UNICODE_IS_LOW_SURROGATE()
      • Py_UNICODE_JOIN_SURROGATES()
    • Creating and accessing Unicode strings
      • PyUnicode_New()
      • PyUnicode_FromKindAndData()
      • PyUnicode_FromStringAndSize()
      • PyUnicode_FromString()
      • PyUnicode_FromFormat()
      • PyUnicode_FromFormatV()
      • PyUnicode_FromEncodedObject()
      • PyUnicode_GetLength()
      • PyUnicode_CopyCharacters()
      • PyUnicode_Fill()
      • PyUnicode_WriteChar()
      • PyUnicode_ReadChar()
      • PyUnicode_Substring()
      • PyUnicode_AsUCS4()
      • PyUnicode_AsUCS4Copy()
    • Deprecated Py_UNICODE APIs
      • PyUnicode_FromUnicode()
      • PyUnicode_AsUnicode()
      • PyUnicode_TransformDecimalToASCII()
      • PyUnicode_AsUnicodeAndSize()
      • PyUnicode_GetSize()
      • PyUnicode_FromObject()
    • Locale Encoding
      • PyUnicode_DecodeLocaleAndSize()
      • PyUnicode_DecodeLocale()
      • PyUnicode_EncodeLocale()
    • File System Encoding
      • PyUnicode_FSConverter()
      • PyUnicode_FSDecoder()
      • PyUnicode_DecodeFSDefaultAndSize()
      • PyUnicode_DecodeFSDefault()
      • PyUnicode_EncodeFSDefault()
    • wchar_t Support
      • PyUnicode_FromWideChar()
      • PyUnicode_AsWideChar()
      • PyUnicode_AsWideCharString()
  • Built-in Codecs
    • Generic Codecs
      • PyUnicode_Decode()
      • PyUnicode_AsEncodedString()
      • PyUnicode_Encode()
    • UTF-8 Codecs
      • PyUnicode_DecodeUTF8()
      • PyUnicode_DecodeUTF8Stateful()
      • PyUnicode_AsUTF8String()
      • PyUnicode_AsUTF8AndSize()
      • PyUnicode_AsUTF8()
      • PyUnicode_EncodeUTF8()
    • UTF-32 Codecs
      • PyUnicode_DecodeUTF32()
      • PyUnicode_DecodeUTF32Stateful()
      • PyUnicode_AsUTF32String()
      • PyUnicode_EncodeUTF32()
    • UTF-16 Codecs
      • PyUnicode_DecodeUTF16()
      • PyUnicode_DecodeUTF16Stateful()
      • PyUnicode_AsUTF16String()
      • PyUnicode_EncodeUTF16()
    • UTF-7 Codecs
      • PyUnicode_DecodeUTF7()
      • PyUnicode_DecodeUTF7Stateful()
      • PyUnicode_EncodeUTF7()
    • Unicode-Escape Codecs
      • PyUnicode_DecodeUnicodeEscape()
      • PyUnicode_AsUnicodeEscapeString()
      • PyUnicode_EncodeUnicodeEscape()
    • Raw-Unicode-Escape Codecs
      • PyUnicode_DecodeRawUnicodeEscape()
      • PyUnicode_AsRawUnicodeEscapeString()
      • PyUnicode_EncodeRawUnicodeEscape()
    • Latin-1 Codecs
      • PyUnicode_DecodeLatin1()
      • PyUnicode_AsLatin1String()
      • PyUnicode_EncodeLatin1()
    • ASCII Codecs
      • PyUnicode_DecodeASCII()
      • PyUnicode_AsASCIIString()
      • PyUnicode_EncodeASCII()
    • Character Map Codecs
      • PyUnicode_DecodeCharmap()
      • PyUnicode_AsCharmapString()
      • PyUnicode_EncodeCharmap()
      • PyUnicode_Translate()
      • PyUnicode_TranslateCharmap()
    • MBCS codecs for Windows
      • PyUnicode_DecodeMBCS()
      • PyUnicode_DecodeMBCSStateful()
      • PyUnicode_AsMBCSString()
      • PyUnicode_EncodeCodePage()
      • PyUnicode_EncodeMBCS()
    • Methods & Slots
  • Methods and Slot Functions
    • PyUnicode_Concat()
    • PyUnicode_Split()
    • PyUnicode_Splitlines()
    • PyUnicode_Join()
    • PyUnicode_Tailmatch()
    • PyUnicode_Find()
    • PyUnicode_FindChar()
    • PyUnicode_Count()
    • PyUnicode_Replace()
    • PyUnicode_Compare()
    • PyUnicode_CompareWithASCIIString()
    • PyUnicode_RichCompare()
    • PyUnicode_Format()
    • PyUnicode_Contains()
    • PyUnicode_InternInPlace()
    • PyUnicode_InternFromString()
• Tuple Objects
  • PyTupleObject
  • PyTuple_Type
  • PyTuple_Check()
  • PyTuple_CheckExact()
  • PyTuple_New()
  • PyTuple_Pack()
  • PyTuple_Size()
  • PyTuple_GET_SIZE()
  • PyTuple_GetItem()
  • PyTuple_GET_ITEM()
  • PyTuple_GetSlice()
  • PyTuple_SetItem()
  • PyTuple_SET_ITEM()
  • _PyTuple_Resize()
• Struct Sequence Objects
  • PyStructSequence_NewType()
  • PyStructSequence_InitType()
  • PyStructSequence_InitType2()
  • PyStructSequence_Desc
  • PyStructSequence_Field
  • PyStructSequence_UnnamedField
  • PyStructSequence_New()
  • PyStructSequence_GetItem()
  • PyStructSequence_GET_ITEM()
  • PyStructSequence_SetItem()
  • PyStructSequence_SET_ITEM()
• List Objects
  • PyListObject
  • PyList_Type
  • PyList_Check()
  • PyList_CheckExact()
  • PyList_New()
  • PyList_Size()
  • PyList_GET_SIZE()
  • PyList_GetItem()
  • PyList_GET_ITEM()
  • PyList_SetItem()
  • PyList_SET_ITEM()
  • PyList_Insert()
  • PyList_Append()
  • PyList_GetSlice()
  • PyList_SetSlice()
  • PyList_Sort()
  • PyList_Reverse()
  • PyList_AsTuple()

Container Objects

• Dictionary Objects
  • PyDictObject
  • PyDict_Type
  • PyDict_Check()
  • PyDict_CheckExact()
  • PyDict_New()
  • PyDictProxy_New()
  • PyDict_Clear()
  • PyDict_Contains()
  • PyDict_Copy()
  • PyDict_SetItem()
  • PyDict_SetItemString()
  • PyDict_DelItem()
  • PyDict_DelItemString()
  • PyDict_GetItem()
  • PyDict_GetItemWithError()
  • PyDict_GetItemString()
  • PyDict_SetDefault()
  • PyDict_Items()
  • PyDict_Keys()
  • PyDict_Values()
  • PyDict_Size()
  • PyDict_Next()
  • PyDict_Merge()
  • PyDict_Update()
  • PyDict_MergeFromSeq2()
• Set Objects
  • PySetObject
  • PySet_Type
  • PyFrozenSet_Type
  • PySet_Check()
  • PyFrozenSet_Check()
  • PyAnySet_Check()
  • PySet_CheckExact()
  • PyAnySet_CheckExact()
  • PyFrozenSet_CheckExact()
  • PySet_New()
  • PyFrozenSet_New()
  • PySet_Size()
  • PySet_GET_SIZE()
  • PySet_Contains()
  • PySet_Add()
  • PySet_Discard()
  • PySet_Pop()
  • PySet_Clear()

Function Objects

• Function Objects
  • PyFunctionObject
  • PyFunction_Type
  • PyFunction_Check()
  • PyFunction_New()
  • PyFunction_NewWithQualName()
  • PyFunction_GetCode()
  • PyFunction_GetGlobals()
  • PyFunction_GetModule()
  • PyFunction_GetDefaults()
  • PyFunction_SetDefaults()
  • PyFunction_GetClosure()
  • PyFunction_SetClosure()
  • PyFunction_GetAnnotations()
  • PyFunction_SetAnnotations()
• Instance Method Objects
  • PyInstanceMethod_Type
  • PyInstanceMethod_Check()
  • PyInstanceMethod_New()
  • PyInstanceMethod_Function()
  • PyInstanceMethod_GET_FUNCTION()
• Method Objects
  • PyMethod_Type
  • PyMethod_Check()
  • PyMethod_New()
  • PyMethod_Function()
  • PyMethod_GET_FUNCTION()
  • PyMethod_Self()
  • PyMethod_GET_SELF()
• Cell Objects
  • PyCellObject
  • PyCell_Type
  • PyCell_Check()
  • PyCell_New()
  • PyCell_Get()
  • PyCell_GET()
  • PyCell_Set()
  • PyCell_SET()
• Code Objects
  • PyCodeObject
  • PyCode_Type
  • PyCode_Check()
  • PyCode_GetNumFree()
  • PyCode_New()
  • PyCode_NewWithPosOnlyArgs()
  • PyCode_NewEmpty()
  • PyCode_Addr2Line()

Other Objects

• File Objects
  • PyFile_FromFd()
  • PyObject_AsFileDescriptor()
  • PyFile_GetLine()
  • PyFile_SetOpenCodeHook()
  • PyFile_WriteObject()
  • PyFile_WriteString()
• Module Objects
  • PyModule_Type
  • PyModule_Check()
  • PyModule_CheckExact()
  • PyModule_NewObject()
  • PyModule_New()
  • PyModule_GetDict()
  • PyModule_GetNameObject()
  • PyModule_GetName()
  • PyModule_GetState()
  • PyModule_GetDef()
  • PyModule_GetFilenameObject()
  • PyModule_GetFilename()
  • Initializing C modules
    • PyModuleDef
      • m_base
      • m_name
      • m_doc
      • m_size
      • m_methods
      • m_slots
        • m_reload
      • m_traverse
      • m_clear
      • m_free
    • Single-phase initialization
      • PyModule_Create()
      • PyModule_Create2()
    • Multi-phase initialization
      • PyModuleDef_Init()
      • PyModuleDef_Slot
        • slot
        • value
      • Py_mod_create
        • create_module()
      • Py_mod_exec
        • exec_module()
    • Low-level module creation functions
      • PyModule_FromDefAndSpec()
      • PyModule_FromDefAndSpec2()
      • PyModule_ExecDef()
      • PyModule_SetDocString()
      • PyModule_AddFunctions()
    • Support functions
      • PyModule_AddObjectRef()
      • PyModule_AddObject()
      • PyModule_AddIntConstant()
      • PyModule_AddStringConstant()
      • PyModule_AddIntMacro()
      • PyModule_AddStringMacro()
      • PyModule_AddType()
  • Module lookup
    • PyState_FindModule()
    • PyState_AddModule()
    • PyState_RemoveModule()
• Iterator Objects
  • PySeqIter_Type
  • PySeqIter_Check()
  • PySeqIter_New()
  • PyCallIter_Type
  • PyCallIter_Check()
  • PyCallIter_New()
• Descriptor Objects
  • PyProperty_Type
  • PyDescr_NewGetSet()
  • PyDescr_NewMember()
  • PyDescr_NewMethod()
  • PyDescr_NewWrapper()
  • PyDescr_NewClassMethod()
  • PyDescr_IsData()
  • PyWrapper_New()
• Slice Objects
  • PySlice_Type
  • PySlice_Check()
  • PySlice_New()
  • PySlice_GetIndices()
  • PySlice_GetIndicesEx()
  • PySlice_Unpack()
  • PySlice_AdjustIndices()
• Ellipsis Object
  • Py_Ellipsis
• MemoryView objects
  • PyMemoryView_FromObject()
  • PyMemoryView_FromMemory()
  • PyMemoryView_FromBuffer()
  • PyMemoryView_GetContiguous()
  • PyMemoryView_Check()
  • PyMemoryView_GET_BUFFER()
  • PyMemoryView_GET_BASE()
• Weak Reference Objects
  • PyWeakref_Check()
  • PyWeakref_CheckRef()
  • PyWeakref_CheckProxy()
  • PyWeakref_NewRef()
  • PyWeakref_NewProxy()
  • PyWeakref_GetObject()
  • PyWeakref_GET_OBJECT()
  • PyObject_ClearWeakRefs()
• Capsules
  • PyCapsule
  • PyCapsule_Destructor
  • PyCapsule_CheckExact()
  • PyCapsule_New()
  • PyCapsule_GetPointer()
  • PyCapsule_GetDestructor()
  • PyCapsule_GetContext()
  • PyCapsule_GetName()
  • PyCapsule_Import()
  • PyCapsule_IsValid()
  • PyCapsule_SetContext()
  • PyCapsule_SetDestructor()
  • PyCapsule_SetName()
  • PyCapsule_SetPointer()
• Generator Objects
  • PyGenObject
  • PyGen_Type
  • PyGen_Check()
  • PyGen_CheckExact()
  • PyGen_New()
  • PyGen_NewWithQualName()
• Coroutine Objects
  • PyCoroObject
  • PyCoro_Type
  • PyCoro_CheckExact()
  • PyCoro_New()
• Context Variables Objects
  • PyContext
  • PyContextVar
  • PyContextToken
  • PyContext_Type
  • PyContextVar_Type
  • PyContextToken_Type
  • PyContext_CheckExact()
  • PyContextVar_CheckExact()
  • PyContextToken_CheckExact()
  • PyContext_New()
  • PyContext_Copy()
  • PyContext_CopyCurrent()
  • PyContext_Enter()
  • PyContext_Exit()
  • PyContextVar_New()
  • PyContextVar_Get()
  • PyContextVar_Set()
  • PyContextVar_Reset()
• DateTime Objects
  • PyDateTime_TimeZone_UTC
  • PyDate_Check()
  • PyDate_CheckExact()
  • PyDateTime_Check()
  • PyDateTime_CheckExact()
  • PyTime_Check()
  • PyTime_CheckExact()
  • PyDelta_Check()
  • PyDelta_CheckExact()
  • PyTZInfo_Check()
  • PyTZInfo_CheckExact()
  • PyDate_FromDate()
  • PyDateTime_FromDateAndTime()
  • PyDateTime_FromDateAndTimeAndFold()
  • PyTime_FromTime()
  • PyTime_FromTimeAndFold()
  • PyDelta_FromDSU()
  • PyTimeZone_FromOffset()
  • PyTimeZone_FromOffsetAndName()
  • PyDateTime_GET_YEAR()
  • PyDateTime_GET_MONTH()
  • PyDateTime_GET_DAY()
  • PyDateTime_DATE_GET_HOUR()
  • PyDateTime_DATE_GET_MINUTE()
  • PyDateTime_DATE_GET_SECOND()
  • PyDateTime_DATE_GET_MICROSECOND()
  • PyDateTime_DATE_GET_FOLD()
  • PyDateTime_DATE_GET_TZINFO()
  • PyDateTime_TIME_GET_HOUR()
  • PyDateTime_TIME_GET_MINUTE()
  • PyDateTime_TIME_GET_SECOND()
  • PyDateTime_TIME_GET_MICROSECOND()
  • PyDateTime_TIME_GET_FOLD()
  • PyDateTime_TIME_GET_TZINFO()
  • PyDateTime_DELTA_GET_DAYS()
  • PyDateTime_DELTA_GET_SECONDS()
  • PyDateTime_DELTA_GET_MICROSECONDS()
  • PyDateTime_FromTimestamp()
  • PyDate_FromTimestamp()
• Objects for Type Hinting
  • Py_GenericAlias()
  • Py_GenericAliasType