blob: a5a4ea446eaad41a324939fa80d9dc131a62364d [file]
<!doctype html><html itemscope itemtype=http://schema.org/WebPage lang=en class=no-js><head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,shrink-to-fit=no"><meta name=robots content="index, follow"><link rel=apple-touch-icon sizes=57x57 href=https://apache.org/favicons/apple-touch-icon-57x57.png><link rel=apple-touch-icon sizes=60x60 href=https://apache.org/favicons/apple-touch-icon-60x60.png><link rel=apple-touch-icon sizes=72x72 href=https://apache.org/favicons/apple-touch-icon-72x72.png><link rel=apple-touch-icon sizes=76x76 href=https://apache.org/favicons/apple-touch-icon-76x76.png><link rel=apple-touch-icon sizes=114x114 href=https://apache.org/favicons/apple-touch-icon-114x114.png><link rel=apple-touch-icon sizes=120x120 href=https://apache.org/favicons/apple-touch-icon-120x120.png><link rel=apple-touch-icon sizes=144x144 href=https://apache.org/favicons/apple-touch-icon-144x144.png><link rel=apple-touch-icon sizes=152x152 href=https://apache.org/favicons/apple-touch-icon-152x152.png><link rel=apple-touch-icon sizes=180x180 href=https://apache.org/favicons/apple-touch-icon-180x180.png><link rel=icon type=image/png href=https://apache.org/favicons/favicon-32x32.png sizes=32x32><link rel=icon type=image/png href=https://apache.org/favicons/favicon-194x194.png sizes=194x194><link rel=icon type=image/png href=https://apache.org/favicons/favicon-96x96.png sizes=96x96><link rel=icon type=image/png href=https://apache.org/favicons/android-chrome-192x192.png sizes=192x192><link rel=icon type=image/png href=https://apache.org/favicons/favicon-16x16.png sizes=16x16><link rel=manifest href=https://apache.org/favicons/manifest.json><link rel="shortcut icon" href=https://apache.org/favicons/favicon.ico><title>Python API | Apache Avro</title>
<meta name=description content="The Python API documentation can be found here."><meta property="og:url" content="/docs/++version++/api-py/"><meta property="og:site_name" content="Apache Avro"><meta property="og:title" content="Python API"><meta property="og:description" content="The Python API documentation can be found here."><meta property="og:locale" content="en"><meta property="og:type" content="article"><meta property="article:section" content="docs"><meta property="article:modified_time" content="2026-05-27T19:59:48+08:00"><meta itemprop=name content="Python API"><meta itemprop=description content="The Python API documentation can be found here."><meta itemprop=dateModified content="2026-05-27T19:59:48+08:00"><meta itemprop=wordCount content="8"><meta name=twitter:card content="summary"><meta name=twitter:title content="Python API"><meta name=twitter:description content="The Python API documentation can be found here."><link rel=preload href=/scss/main.min.cbf108fc68752c77d6b54d7783019a796735b379026275582fdbbb90ba6500b7.css as=style><link href=/scss/main.min.cbf108fc68752c77d6b54d7783019a796735b379026275582fdbbb90ba6500b7.css rel=stylesheet integrity><script src=https://code.jquery.com/jquery-3.7.1.min.js integrity="sha512-v2CJ7UaYy4JwqLDIrZUI/4hqeoQieOmAZNXBeQyjo21dadnwR+8ZaIJVT8EE2iyI61OV8e6M8PP2/4hpQINQ/g==" crossorigin=anonymous></script><link rel=stylesheet href=/css/prism.css></head><body class=td-page><header><nav class="js-navbar-scroll navbar navbar-expand navbar-dark flex-column flex-md-row td-navbar"><a class=navbar-brand href=/><span class=navbar-logo><img src=/images/logo.svg width=35 height=30 style="margin:0 10px"></span><span class=font-weight-bold>Apache Avro</span></a><div class="td-navbar-nav-scroll ml-md-auto" id=main_navbar><ul class="navbar-nav mt-2 mt-lg-0"><li class="nav-item mr-4 mb-2 mb-lg-0"><a class=nav-link href=/project/><span>Project</span></a></li><li class="nav-item mr-4 mb-2 mb-lg-0"><a class=nav-link href=/blog/><span>Blog</span></a></li><li class="nav-item mr-4 mb-2 mb-lg-0"><a class=nav-link href=/community/><span>Community</span></a></li><li class="nav-item dropdown mr-4 d-none d-lg-block"><div class=dropdown><button class="nav-link btn btn-secondary dropdown-toggle" type=button id=navbarDropdown data-bs-toggle=dropdown aria-expanded=false>
Documentation</button><ul class=dropdown-menu><li><a class=dropdown-item href=https://avro.apache.org/docs/1.12.0/>1.12.0</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.11.4/>1.11.4</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.11.3/>1.11.3</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.11.2/>1.11.2</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.11.1/>1.11.1</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.11.0/>1.11.0</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.10.2/>1.10.2</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.10.1/>1.10.1</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.10.0/>1.10.0</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.9.2/>1.9.2</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.9.1/>1.9.1</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.9.0/>1.9.0</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.8.2/>1.8.2</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.8.1/>1.8.1</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.8.0/>1.8.0</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.7.7/>1.7.7</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.7.6/>1.7.6</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.7.5/>1.7.5</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.7.4/>1.7.4</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.7.3/>1.7.3</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.7.2/>1.7.2</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.7.1/>1.7.1</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.7.0/>1.7.0</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.6.3/>1.6.3</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.6.2/>1.6.2</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.6.1/>1.6.1</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.6.0/>1.6.0</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.5.4/>1.5.4</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.5.3/>1.5.3</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.5.2/>1.5.2</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.5.1/>1.5.1</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.5.0/>1.5.0</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.4.1/>1.4.1</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.4.0/>1.4.0</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.3.3/>1.3.3</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.3.2/>1.3.2</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.3.1/>1.3.1</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.3.0/>1.3.0</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.2.0/>1.2.0</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.1.0/>1.1.0</a></li><li><a class=dropdown-item href=https://avro.apache.org/docs/1.0.0/>1.0.0</a></li></ul></div></li><li class="nav-item dropdown mr-4 d-none d-lg-block"><div class=dropdown><button class="nav-link btn btn-secondary dropdown-toggle" type=button id=navbarDropdown data-bs-toggle=dropdown aria-expanded=false>
ASF links</button><ul class=dropdown-menu><a class=dropdown-item href=http://www.apache.org/ target=_blank>ASF Web Site</a>
<a class=dropdown-item href=http://www.apache.org/licenses/ target=_blank>License</a>
<a class=dropdown-item href=http://www.apache.org/foundation/sponsorship.html target=_blank>Donate</a>
<a class=dropdown-item href=http://www.apache.org/foundation/thanks.html target=_blank>Thanks</a>
<a class=dropdown-item href=http://www.apache.org/security/ target=_blank>Security</a></ul></div></li></ul></div><div class="navbar-nav d-none d-lg-block"></div></nav></header><div class="container-fluid td-outer"><div class=td-main><div class="row flex-xl-nowrap"><aside class="col-12 col-md-3 col-xl-2 td-sidebar d-print-none"><div id=td-sidebar-menu class=td-sidebar__inner><div id=content-mobile><form class="td-sidebar__search d-flex align-items-center"><button class="btn btn-link td-sidebar__toggle d-md-none p-0 ms-3 fas fa-bars" type=button data-bs-toggle=collapse data-bs-target=#td-section-nav aria-controls=td-section-nav aria-expanded=false aria-label="Toggle section navigation"></button></form></div><div id=content-desktop></div><nav class="td-sidebar-nav collapse td-sidebar-nav--search-disabled foldable-nav" id=td-section-nav><div class="td-sidebar-nav__section nav-item dropdown d-block d-lg-none"><div class=dropdown><a class="nav-link dropdown-toggle" href=# role=button data-bs-toggle=dropdown aria-haspopup=true aria-expanded=false></a><ul class=dropdown-menu><li><a class=dropdown-item href=/params/></a></li></ul></div></div><ul class="td-sidebar-nav__section pe-md-3 ul-0"><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child active-path" id=m-docs-li><a href=/docs/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section tree-root" id=m-docs><span>Documentation</span></a><ul class=ul-1><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child active-path" id=m-docsversion-li><input type=checkbox id=m-docsversion-check checked>
<label for=m-docsversion-check><a href=/docs/++version++/ title="Apache Avro™ ++version++ Documentation" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docsversion><span>++version++</span></a></label><ul class="ul-2 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docsversiongetting-started-java-li><input type=checkbox id=m-docsversiongetting-started-java-check>
<label for=m-docsversiongetting-started-java-check><a href=/docs/++version++/getting-started-java/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docsversiongetting-started-java><span>Getting Started (Java)</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docsversiongetting-started-python-li><input type=checkbox id=m-docsversiongetting-started-python-check>
<label for=m-docsversiongetting-started-python-check><a href=/docs/++version++/getting-started-python/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docsversiongetting-started-python><span>Getting Started (Python)</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docsversionspecification-li><input type=checkbox id=m-docsversionspecification-check>
<label for=m-docsversionspecification-check><a href=/docs/++version++/specification/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docsversionspecification><span>Specification</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docsversionapi-java-li><input type=checkbox id=m-docsversionapi-java-check>
<label for=m-docsversionapi-java-check><a href=/docs/++version++/api/java/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docsversionapi-java><span>Java API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docsversionapi-c-li><input type=checkbox id=m-docsversionapi-c-check>
<label for=m-docsversionapi-c-check><a href=/docs/++version++/api/c/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docsversionapi-c><span>C API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docsversionapi-c-li><input type=checkbox id=m-docsversionapi-c-check>
<label for=m-docsversionapi-c-check><a href=/docs/++version++/api/cpp/html/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docsversionapi-c><span>C++ API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docsversionapi-csharp-li><input type=checkbox id=m-docsversionapi-csharp-check>
<label for=m-docsversionapi-csharp-check><a href=/docs/++version++/api/csharp/html/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docsversionapi-csharp><span>C# API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child active-path" id=m-docsversionapi-py-li><input type=checkbox id=m-docsversionapi-py-check checked>
<label for=m-docsversionapi-py-check><a href=/docs/++version++/api/py/html/ class="align-left ps-0 active td-sidebar-link td-sidebar-link__page" id=m-docsversionapi-py><span class=td-sidebar-nav-active-item>Python API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docsversionapi-rust-li><input type=checkbox id=m-docsversionapi-rust-check>
<label for=m-docsversionapi-rust-check><a href=/docs/++version++/api/rust/apache_avro/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docsversionapi-rust><span>Rust API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docsversionmapreduce-guide-li><input type=checkbox id=m-docsversionmapreduce-guide-check>
<label for=m-docsversionmapreduce-guide-check><a href=/docs/++version++/mapreduce-guide/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docsversionmapreduce-guide><span>MapReduce guide</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docsversionidl-language-li><input type=checkbox id=m-docsversionidl-language-check>
<label for=m-docsversionidl-language-check><a href=/docs/++version++/idl-language/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docsversionidl-language><span>IDL Language</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docsversionsasl-profile-li><input type=checkbox id=m-docsversionsasl-profile-check>
<label for=m-docsversionsasl-profile-check><a href=/docs/++version++/sasl-profile/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docsversionsasl-profile><span>SASL profile</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docsversioneditor-support-li><input type=checkbox id=m-docsversioneditor-support-check>
<label for=m-docsversioneditor-support-check><a href=/docs/++version++/editor-support/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docsversioneditor-support><span>Editor Support</span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-docs1120-li><input type=checkbox id=m-docs1120-check>
<label for=m-docs1120-check><a href=/docs/1.12.0/ title="Apache Avro™ 1.12.0 Documentation" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1120><span>1.12.0</span></a></label><ul class="ul-2 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1120getting-started-java-li><input type=checkbox id=m-docs1120getting-started-java-check>
<label for=m-docs1120getting-started-java-check><a href=/docs/1.12.0/getting-started-java/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1120getting-started-java><span>Getting Started (Java)</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1120getting-started-python-li><input type=checkbox id=m-docs1120getting-started-python-check>
<label for=m-docs1120getting-started-python-check><a href=/docs/1.12.0/getting-started-python/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1120getting-started-python><span>Getting Started (Python)</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1120specification-li><input type=checkbox id=m-docs1120specification-check>
<label for=m-docs1120specification-check><a href=/docs/1.12.0/specification/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1120specification><span>Specification</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1120api-java-li><input type=checkbox id=m-docs1120api-java-check>
<label for=m-docs1120api-java-check><a href=/docs/1.12.0/api/java/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1120api-java><span>Java API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1120api-c-li><input type=checkbox id=m-docs1120api-c-check>
<label for=m-docs1120api-c-check><a href=/docs/1.12.0/api/c/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1120api-c><span>C API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1120api-c-li><input type=checkbox id=m-docs1120api-c-check>
<label for=m-docs1120api-c-check><a href=/docs/1.12.0/api/cpp/html/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1120api-c><span>C++ API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1120api-csharp-li><input type=checkbox id=m-docs1120api-csharp-check>
<label for=m-docs1120api-csharp-check><a href=/docs/1.12.0/api/csharp/html/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1120api-csharp><span>C# API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1120api-py-li><input type=checkbox id=m-docs1120api-py-check>
<label for=m-docs1120api-py-check><a href=/docs/1.12.0/api/py/html/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1120api-py><span>Python API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1120mapreduce-guide-li><input type=checkbox id=m-docs1120mapreduce-guide-check>
<label for=m-docs1120mapreduce-guide-check><a href=/docs/1.12.0/mapreduce-guide/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1120mapreduce-guide><span>MapReduce guide</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1120idl-language-li><input type=checkbox id=m-docs1120idl-language-check>
<label for=m-docs1120idl-language-check><a href=/docs/1.12.0/idl-language/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1120idl-language><span>IDL Language</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1120sasl-profile-li><input type=checkbox id=m-docs1120sasl-profile-check>
<label for=m-docs1120sasl-profile-check><a href=/docs/1.12.0/sasl-profile/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1120sasl-profile><span>SASL profile</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1120trevni-li><input type=checkbox id=m-docs1120trevni-check>
<label for=m-docs1120trevni-check><a href=/docs/1.12.0/trevni/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1120trevni><span></span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-docs1114-li><input type=checkbox id=m-docs1114-check>
<label for=m-docs1114-check><a href=/docs/1.11.4/ title="Apache Avro™ 1.11.4 Documentation" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1114><span>1.11.4</span></a></label><ul class="ul-2 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1114getting-started-java-li><input type=checkbox id=m-docs1114getting-started-java-check>
<label for=m-docs1114getting-started-java-check><a href=/docs/1.11.4/getting-started-java/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1114getting-started-java><span>Getting Started (Java)</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1114getting-started-python-li><input type=checkbox id=m-docs1114getting-started-python-check>
<label for=m-docs1114getting-started-python-check><a href=/docs/1.11.4/getting-started-python/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1114getting-started-python><span>Getting Started (Python)</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1114specification-li><input type=checkbox id=m-docs1114specification-check>
<label for=m-docs1114specification-check><a href=/docs/1.11.4/specification/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1114specification><span>Specification</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1114api-java-li><input type=checkbox id=m-docs1114api-java-check>
<label for=m-docs1114api-java-check><a href=/docs/1.11.4/api/java/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1114api-java><span>Java API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1114api-c-li><input type=checkbox id=m-docs1114api-c-check>
<label for=m-docs1114api-c-check><a href=/docs/1.11.4/api/c/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1114api-c><span>C API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1114api-c-li><input type=checkbox id=m-docs1114api-c-check>
<label for=m-docs1114api-c-check><a href=/docs/1.11.4/api/cpp/html/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1114api-c><span>C++ API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1114api-csharp-li><input type=checkbox id=m-docs1114api-csharp-check>
<label for=m-docs1114api-csharp-check><a href=/docs/1.11.4/api/csharp/html/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1114api-csharp><span>C# API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1114api-py-li><input type=checkbox id=m-docs1114api-py-check>
<label for=m-docs1114api-py-check><a href=/docs/1.11.4/api/py/html/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1114api-py><span>Python API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1114mapreduce-guide-li><input type=checkbox id=m-docs1114mapreduce-guide-check>
<label for=m-docs1114mapreduce-guide-check><a href=/docs/1.11.4/mapreduce-guide/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1114mapreduce-guide><span>MapReduce guide</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1114idl-language-li><input type=checkbox id=m-docs1114idl-language-check>
<label for=m-docs1114idl-language-check><a href=/docs/1.11.4/idl-language/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1114idl-language><span>IDL Language</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1114sasl-profile-li><input type=checkbox id=m-docs1114sasl-profile-check>
<label for=m-docs1114sasl-profile-check><a href=/docs/1.11.4/sasl-profile/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1114sasl-profile><span>SASL profile</span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-docs1113-li><input type=checkbox id=m-docs1113-check>
<label for=m-docs1113-check><a href=/docs/1.11.3/ title="Apache Avro™ 1.11.3 Documentation" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1113><span>1.11.3</span></a></label><ul class="ul-2 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1113getting-started-java-li><input type=checkbox id=m-docs1113getting-started-java-check>
<label for=m-docs1113getting-started-java-check><a href=/docs/1.11.3/getting-started-java/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1113getting-started-java><span>Getting Started (Java)</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1113getting-started-python-li><input type=checkbox id=m-docs1113getting-started-python-check>
<label for=m-docs1113getting-started-python-check><a href=/docs/1.11.3/getting-started-python/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1113getting-started-python><span>Getting Started (Python)</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1113specification-li><input type=checkbox id=m-docs1113specification-check>
<label for=m-docs1113specification-check><a href=/docs/1.11.3/specification/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1113specification><span>Specification</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1113api-java-li><input type=checkbox id=m-docs1113api-java-check>
<label for=m-docs1113api-java-check><a href=/docs/1.11.3/api/java/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1113api-java><span>Java API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1113api-c-li><input type=checkbox id=m-docs1113api-c-check>
<label for=m-docs1113api-c-check><a href=/docs/1.11.3/api/c/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1113api-c><span>C API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1113api-c-li><input type=checkbox id=m-docs1113api-c-check>
<label for=m-docs1113api-c-check><a href=/docs/1.11.3/api/cpp/html/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1113api-c><span>C++ API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1113api-csharp-li><input type=checkbox id=m-docs1113api-csharp-check>
<label for=m-docs1113api-csharp-check><a href=/docs/1.11.3/api/csharp/html/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1113api-csharp><span>C# API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1113api-py-li><input type=checkbox id=m-docs1113api-py-check>
<label for=m-docs1113api-py-check><a href=/docs/1.11.3/api/py/html/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1113api-py><span>Python API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1113mapreduce-guide-li><input type=checkbox id=m-docs1113mapreduce-guide-check>
<label for=m-docs1113mapreduce-guide-check><a href=/docs/1.11.3/mapreduce-guide/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1113mapreduce-guide><span>MapReduce guide</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1113idl-language-li><input type=checkbox id=m-docs1113idl-language-check>
<label for=m-docs1113idl-language-check><a href=/docs/1.11.3/idl-language/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1113idl-language><span>IDL Language</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1113sasl-profile-li><input type=checkbox id=m-docs1113sasl-profile-check>
<label for=m-docs1113sasl-profile-check><a href=/docs/1.11.3/sasl-profile/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1113sasl-profile><span>SASL profile</span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-docs1112-li><input type=checkbox id=m-docs1112-check>
<label for=m-docs1112-check><a href=/docs/1.11.2/ title="Apache Avro™ 1.11.2 Documentation" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1112><span>1.11.2</span></a></label><ul class="ul-2 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1112getting-started-java-li><input type=checkbox id=m-docs1112getting-started-java-check>
<label for=m-docs1112getting-started-java-check><a href=/docs/1.11.2/getting-started-java/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1112getting-started-java><span>Getting Started (Java)</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1112getting-started-python-li><input type=checkbox id=m-docs1112getting-started-python-check>
<label for=m-docs1112getting-started-python-check><a href=/docs/1.11.2/getting-started-python/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1112getting-started-python><span>Getting Started (Python)</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1112specification-li><input type=checkbox id=m-docs1112specification-check>
<label for=m-docs1112specification-check><a href=/docs/1.11.2/specification/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1112specification><span>Specification</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1112api-java-li><input type=checkbox id=m-docs1112api-java-check>
<label for=m-docs1112api-java-check><a href=/docs/1.11.2/api/java/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1112api-java><span>Java API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1112api-c-li><input type=checkbox id=m-docs1112api-c-check>
<label for=m-docs1112api-c-check><a href=/docs/1.11.2/api/c/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1112api-c><span>C API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1112api-c-li><input type=checkbox id=m-docs1112api-c-check>
<label for=m-docs1112api-c-check><a href=/docs/1.11.2/api/cpp/html/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1112api-c><span>C++ API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1112api-csharp-li><input type=checkbox id=m-docs1112api-csharp-check>
<label for=m-docs1112api-csharp-check><a href=/docs/1.11.2/api/csharp/html/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1112api-csharp><span>C# API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1112mapreduce-guide-li><input type=checkbox id=m-docs1112mapreduce-guide-check>
<label for=m-docs1112mapreduce-guide-check><a href=/docs/1.11.2/mapreduce-guide/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1112mapreduce-guide><span>MapReduce guide</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1112idl-language-li><input type=checkbox id=m-docs1112idl-language-check>
<label for=m-docs1112idl-language-check><a href=/docs/1.11.2/idl-language/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1112idl-language><span>IDL Language</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1112sasl-profile-li><input type=checkbox id=m-docs1112sasl-profile-check>
<label for=m-docs1112sasl-profile-check><a href=/docs/1.11.2/sasl-profile/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1112sasl-profile><span>SASL profile</span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-docs1111-li><input type=checkbox id=m-docs1111-check>
<label for=m-docs1111-check><a href=/docs/1.11.1/ title="Apache Avro™ 1.11.1 Documentation" class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1111><span>1.11.1</span></a></label><ul class="ul-2 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1111getting-started-java-li><input type=checkbox id=m-docs1111getting-started-java-check>
<label for=m-docs1111getting-started-java-check><a href=/docs/1.11.1/getting-started-java/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1111getting-started-java><span>Getting Started (Java)</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1111getting-started-python-li><input type=checkbox id=m-docs1111getting-started-python-check>
<label for=m-docs1111getting-started-python-check><a href=/docs/1.11.1/getting-started-python/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1111getting-started-python><span>Getting Started (Python)</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1111specification-li><input type=checkbox id=m-docs1111specification-check>
<label for=m-docs1111specification-check><a href=/docs/1.11.1/specification/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1111specification><span>Specification</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1111api-java-li><input type=checkbox id=m-docs1111api-java-check>
<label for=m-docs1111api-java-check><a href=/docs/1.11.1/api/java/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1111api-java><span>Java API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1111api-c-li><input type=checkbox id=m-docs1111api-c-check>
<label for=m-docs1111api-c-check><a href=/docs/1.11.1/api/c/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1111api-c><span>C API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1111api-c-li><input type=checkbox id=m-docs1111api-c-check>
<label for=m-docs1111api-c-check><a href=/docs/1.11.1/api/cpp/html/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1111api-c><span>C++ API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1111api-csharp-li><input type=checkbox id=m-docs1111api-csharp-check>
<label for=m-docs1111api-csharp-check><a href=/docs/1.11.1/api/csharp/html/ class="align-left ps-0 td-sidebar-link td-sidebar-link__page" id=m-docs1111api-csharp><span>C# API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1111mapreduce-guide-li><input type=checkbox id=m-docs1111mapreduce-guide-check>
<label for=m-docs1111mapreduce-guide-check><a href=/docs/1.11.1/mapreduce-guide/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1111mapreduce-guide><span>MapReduce guide</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1111idl-language-li><input type=checkbox id=m-docs1111idl-language-check>
<label for=m-docs1111idl-language-check><a href=/docs/1.11.1/idl-language/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1111idl-language><span>IDL Language</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docs1111sasl-profile-li><input type=checkbox id=m-docs1111sasl-profile-check>
<label for=m-docs1111sasl-profile-check><a href=/docs/1.11.1/sasl-profile/ class="align-left ps-0 td-sidebar-link td-sidebar-link__section" id=m-docs1111sasl-profile><span>SASL profile</span></a></label></li></ul></li></ul></li></ul></nav></div></aside><aside class="d-none d-xl-block col-xl-2 td-sidebar-toc d-print-none"><div class="td-page-meta ms-2 pb-1 pt-2 mb-0"><a href=https://github.com/apache/avro/tree/main/doc/content/en/docs/++version++/api-py.md class="td-page-meta--view td-page-meta__view" target=_blank rel=noopener><i class="fa-solid fa-file-lines fa-fw"></i> View page source</a>
<a href=https://github.com/apache/avro/edit/main/doc/content/en/docs/++version++/api-py.md class="td-page-meta--edit td-page-meta__edit" target=_blank rel=noopener><i class="fa-solid fa-pen-to-square fa-fw"></i> Edit this page</a>
<a href="https://github.com/apache/avro/new/main/doc/content/en/docs/++version++?filename=change-me.md&amp;value=---%0Atitle%3A+%22Long+Page+Title%22%0AlinkTitle%3A+%22Short+Nav+Title%22%0Aweight%3A+100%0Adescription%3A+%3E-%0A+++++Page+description+for+heading+and+indexes.%0A---%0A%0A%23%23+Heading%0A%0AEdit+this+template+to+create+your+new+page.%0A%0A%2A+Give+it+a+good+name%2C+ending+in+%60.md%60+-+e.g.+%60getting-started.md%60%0A%2A+Edit+the+%22front+matter%22+section+at+the+top+of+the+page+%28weight+controls+how+its+ordered+amongst+other+pages+in+the+same+directory%3B+lowest+number+first%29.%0A%2A+Add+a+good+commit+message+at+the+bottom+of+the+page+%28%3C80+characters%3B+use+the+extended+description+field+for+more+detail%29.%0A%2A+Create+a+new+branch+so+you+can+preview+your+new+file+and+request+a+review+via+Pull+Request.%0A" class="td-page-meta--child td-page-meta__child" target=_blank rel=noopener><i class="fa-solid fa-pen-to-square fa-fw"></i> Create child page</a>
<a href="https://github.com/apache/avro/issues/new?title=Python%20API" class="td-page-meta--issue td-page-meta__issue" target=_blank rel=noopener><i class="fa-solid fa-list-check fa-fw"></i> Create documentation issue</a>
<a href=https://github.com/apache/avro/issues/new class="td-page-meta--project td-page-meta__project-issue" target=_blank rel=noopener><i class="fa-solid fa-list-check fa-fw"></i> Create project issue</a>
<a id=print href=/docs/++version++/_print/><i class="fa-solid fa-print fa-fw"></i> Print entire section</a></div><div class="taxonomy taxonomy-terms-cloud taxo-tags"><h5 class=taxonomy-title>Tag Cloud</h5><ul class=taxonomy-terms><li><a class=taxonomy-term href=/tags/java/ data-taxonomy-term=java><span class=taxonomy-label>Java</span><span class=taxonomy-count>6</span></a></li><li><a class=taxonomy-term href=/tags/python/ data-taxonomy-term=python><span class=taxonomy-label>Python</span><span class=taxonomy-count>6</span></a></li></ul></div></aside><main class="col-12 col-md-9 col-xl-8 ps-md-5" role=main><nav aria-label=breadcrumb class=td-breadcrumbs><ol class=breadcrumb><li class=breadcrumb-item><a href=/docs/>Documentation</a></li><li class=breadcrumb-item><a href=/docs/++version++/>++version++</a></li><li class="breadcrumb-item active" aria-current=page>Python API</li></ol></nav><div class=td-content><h1>Python API</h1><header class=article-meta><p class=reading-time><i class="fa-solid fa-clock" aria-hidden=true></i>&nbsp; less than a minute &nbsp;</p></header><p>The Python API documentation can be found <a href=/docs/++version++/api/py/html/>here</a>.</p><div class=td-page-meta__lastmod>Last modified May 27, 2026: <a href=https://github.com/apache/avro/commit/66e29f38608e987e96e27f5e06c27eb0f61bd24f>AVRO-4260: [C++] Upgrade minimum C++ standard from C++17 to C++20 (#3800) (66e29f3)</a></div></div></main></div></div><footer class="bg-dark py-5 row d-print-none"><div class="container-fluid mx-sm-5"><div class=row><div class="col-4 col-sm-3 text-xs-center order-sm-2"><ul class="list-inline mb-0"><li class="list-inline-item mx-2 h3" data-toggle=tooltip data-placement=top title="User mailing list" aria-label="User mailing list"><a class=text-white target=_blank rel=noopener href=https://lists.apache.org/list.html?user@avro.apache.org aria-label="User mailing list"><i class="fa fa-envelope"></i></a></li><li class="list-inline-item mx-2 h3" data-toggle=tooltip data-placement=top title=Twitter aria-label=Twitter><a class=text-white target=_blank rel=noopener href=https://twitter.com/ApacheAvro aria-label=Twitter><i class="fab fa-twitter"></i></a></li><li class="list-inline-item mx-2 h3" data-toggle=tooltip data-placement=top title="Stack Overflow" aria-label="Stack Overflow"><a class=text-white target=_blank rel=noopener href=https://stackoverflow.com/questions/tagged/avro aria-label="Stack Overflow"><i class="fab fa-stack-overflow"></i></a></li></ul></div><div class="col-4 col-sm-3 text-right text-xs-center order-sm-3"><ul class="list-inline mb-0"><li class="list-inline-item mx-2 h3" data-toggle=tooltip data-placement=top title=GitHub aria-label=GitHub><a class=text-white target=_blank rel=noopener href=https://github.com/apache/avro aria-label=GitHub><i class="fab fa-github"></i></a></li><li class="list-inline-item mx-2 h3" data-toggle=tooltip data-placement=top title=Issues aria-label=Issues><a class=text-white target=_blank rel=noopener href=https://issues.apache.org/jira/projects/AVRO/issues aria-label=Issues><i class="fab fa-jira"></i></a></li><li class="list-inline-item mx-2 h3" data-toggle=tooltip data-placement=top title="Chat with other project developers at Slack" aria-label="Chat with other project developers at Slack"><a class=text-white target=_blank rel=noopener href=https://the-asf.slack.com/ aria-label="Chat with other project developers at Slack"><i class="fab fa-slack"></i></a></li><li class="list-inline-item mx-2 h3" data-toggle=tooltip data-placement=top title="Developer mailing list" aria-label="Developer mailing list"><a class=text-white target=_blank rel=noopener href=https://lists.apache.org/list.html?dev@avro.apache.org aria-label="Developer mailing list"><i class="fa fa-envelope"></i></a></li></ul></div><div class="col-10 col-sm-3 text-center py-2 order-sm-2"><a href=https://www.apache.org/><small class=text-white>&copy; 2026 The Apache Software Foundation </small></a><small class=text-white>All Rights Reserved</small><p><small class=text-white>Apache Avro, Avro&trade;, Apache&reg;, and the Apache feather logo are either registered trademarks or trademarks of The Apache Software Foundation.</small></p></div><div class="col-5 col-sm-3 order-sm-2"><a href=https://www.apache.org/events/current-event.html><img src=https://www.apache.org/events/current-event-234x60.png></a></div></div></div></footer></div><script src=/js/main.min.1b64887c572e23a206e20c997f04baa7fda8d02b725cfd4a4f71f036f2391251.js integrity="sha256-G2SIfFcuI6IG4gyZfwS6p/2o0CtyXP1KT3HwNvI5ElE=" crossorigin=anonymous></script><script src=/js/prism.js></script><script src=/js/tabpane-persist.js></script></body></html>