<html xmlns="http://www.w3.org/1999/xhtml" lang="ja">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>codec レジストリとサポート関数 &#8212; Python 3.6.5 ドキュメント</title>

<link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" />

<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

<script type="text/javascript">

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '3.6.5',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

<script type="text/javascript" src="../_static/jquery.js"></script>

<script type="text/javascript" src="../_static/underscore.js"></script>

<script type="text/javascript" src="../_static/doctools.js"></script>

<script type="text/javascript" src="../_static/translations.js"></script>

<script type="text/javascript" src="../_static/sidebar.js"></script>

<link rel="search" type="application/opensearchdescription+xml"

title="Python 3.6.5 ドキュメント 内を検索"

href="../_static/opensearch.xml"/>

<link rel="author" title="このドキュメントについて" href="../about.html" />

<link rel="index" title="索引" href="../genindex.html" />

<link rel="search" title="検索" href="../search.html" />

<link rel="copyright" title="Copyright" href="../copyright.html" />

<link rel="next" title="抽象オブジェクトレイヤ (abstract objects layer)" href="abstract.html" />

<link rel="prev" title="リフレクション" href="reflection.html" />

<link rel="shortcut icon" type="image/png" href="../_static/py.png" />

<link rel="canonical" href="https://docs.python.jp/3/c-api/codec.html" /><script type="text/javascript">

$(document).ready(function() {

var base = 'https://docs.python.org/3.6/c-api/codec.html';

$('a.headerlink').each(function() {

var html = '<a href="' + base + $(this).attr('href') +

'" title="原文へのリンク"><small>(原文)</small></a>';

$(this).after(html);

})

});

</script>

<script type="text/javascript" src="../_static/copybutton.js"></script>

<script type="text/javascript" src="../_static/version_switch.js"></script>

</head>

<body>

<div class="related" role="navigation" aria-label="related navigation">

<h3>ナビゲーション</h3>

<ul>

<li class="right" style="margin-right: 10px">

<a href="../genindex.html" title="総索引"

accesskey="I">索引</a></li>

<li class="right" >

<a href="../py-modindex.html" title="Pythonモジュール索引"

>モジュール</a> |</li>

<li class="right" >

<a href="abstract.html" title="抽象オブジェクトレイヤ (abstract objects layer)"

accesskey="N">次へ</a> |</li>

<li class="right" >

<a href="reflection.html" title="リフレクション"

accesskey="P">前へ</a> |</li>

<li><img src="../_static/py.png" alt=""

style="vertical-align: middle; margin-top: -1px"/></li>

<li><a href="https://www.python.org/">Python</a> &#187;</li>

<li>

<span class="version_switcher_placeholder">3.6.5</span>

<a href="../index.html">ドキュメント</a> &#187;

</li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API リファレンスマニュアル</a> &#187;</li>

<li class="nav-item nav-item-2"><a href="utilities.html" accesskey="U">ユーティリティ</a> &#187;</li>

<li class="right">

<div class="inline-search" style="display: none" role="search">

<form class="inline-search" action="../search.html" method="get">

<input placeholder="Quick search" type="text" name="q" />

<input type="submit" value="Go" />

<input type="hidden" name="check_keywords" value="yes" />

<input type="hidden" name="area" value="default" />

</form>

</div>

<script type="text/javascript">$('.inline-search').show(0);</script>

|

</li>

</ul>

</div>

<div class="document">

<div class="documentwrapper">

<div class="bodywrapper">

<div class="body" role="main">

<div class="section" id="codec-registry-and-support-functions">

<span id="codec-registry"></span><h1>codec レジストリとサポート関数<a class="headerlink" href="#codec-registry-and-support-functions" title="このヘッドラインへのパーマリンク">¶</a></h1>

<dl class="function">

<dt id="c.PyCodec_Register">

int <code class="descname">PyCodec_Register</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em>&nbsp;*search_function</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_Register" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>新しい codec 検索関数を登録します。</p>

<p>副作用として、この関数は <code class="xref py py-mod docutils literal"><span class="pre">encodings</span></code> パッケージが常に検索関数の先頭に来るように、まだロードされていない場合はロードします。</p>

<dl class="function">

<dt id="c.PyCodec_KnownEncoding">

int <code class="descname">PyCodec_KnownEncoding</code><span class="sig-paren">(</span>const char<em>&nbsp;*encoding</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_KnownEncoding" title="この定義へのパーマリンク">¶</a></dt>

<dd><p><em>encoding</em> のための登録された codec が存在するかどうかに応じて <code class="docutils literal"><span class="pre">1</span></code> か <code class="docutils literal"><span class="pre">0</span></code> を返します。</p>

<dl class="function">

<dt id="c.PyCodec_Encode">

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyCodec_Encode</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em>&nbsp;*object</em>, const char<em>&nbsp;*encoding</em>, const char<em>&nbsp;*errors</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_Encode" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>汎用の codec ベースの encode API.</p>

<p><em>encoding</em> に応じて見つかったエンコーダ関数に対して <em>object</em> を渡します。エラーハンドリングメソッドは <em>errors</em> で指定します。 <em>errors</em> は <em>NULL</em> でもよく、その場合はその codec のデフォルトのメソッドが利用されます。エンコーダが見つからなかった場合は <a class="reference internal" href="../library/exceptions.html#LookupError" title="LookupError"><code class="xref py py-exc docutils literal"><span class="pre">LookupError</span></code></a> を発生させます。</p>

<dl class="function">

<dt id="c.PyCodec_Decode">

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyCodec_Decode</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em>&nbsp;*object</em>, const char<em>&nbsp;*encoding</em>, const char<em>&nbsp;*errors</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_Decode" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>汎用の codec ベースのデコード API.</p>

<p><em>encoding</em> に応じて見つかったデコーダ関数に対して <em>object</em> を渡します。エラーハンドリングメソッドは <em>errors</em> で指定します。 <em>errors</em> は <em>NULL</em> でもよく、その場合はその codec のデフォルトのメソッドが利用されます。デコーダが見つからなかった場合は <a class="reference internal" href="../library/exceptions.html#LookupError" title="LookupError"><code class="xref py py-exc docutils literal"><span class="pre">LookupError</span></code></a> を発生させます。</p>

<div class="section" id="codec-lookup-api">

<h2>コーデック検索API<a class="headerlink" href="#codec-lookup-api" title="このヘッドラインへのパーマリンク">¶</a></h2>

<p>以下の関数では、文字列 <em>encoding</em> は全て小文字に変換することで、効率的に、大文字小文字を無視した検索をします。コーデックが見つからない場合、 <a class="reference internal" href="../library/exceptions.html#KeyError" title="KeyError"><code class="xref py py-exc docutils literal"><span class="pre">KeyError</span></code></a> を設定して <em>NULL</em> を返します。</p>

<dl class="function">

<dt id="c.PyCodec_Encoder">

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyCodec_Encoder</code><span class="sig-paren">(</span>const char<em>&nbsp;*encoding</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_Encoder" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>与えられた <em>encoding</em> のエンコーダ関数を返します。</p>

<dl class="function">

<dt id="c.PyCodec_Decoder">

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyCodec_Decoder</code><span class="sig-paren">(</span>const char<em>&nbsp;*encoding</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_Decoder" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>与えられた <em>encoding</em> のデコーダ関数を返します。</p>

<dl class="function">

<dt id="c.PyCodec_IncrementalEncoder">

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyCodec_IncrementalEncoder</code><span class="sig-paren">(</span>const char<em>&nbsp;*encoding</em>, const char<em>&nbsp;*errors</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_IncrementalEncoder" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>与えられた <em>encoding</em> の <a class="reference internal" href="../library/codecs.html#codecs.IncrementalEncoder" title="codecs.IncrementalEncoder"><code class="xref py py-class docutils literal"><span class="pre">IncrementalEncoder</span></code></a> オブジェクトを返します。</p>

<dl class="function">

<dt id="c.PyCodec_IncrementalDecoder">

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyCodec_IncrementalDecoder</code><span class="sig-paren">(</span>const char<em>&nbsp;*encoding</em>, const char<em>&nbsp;*errors</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_IncrementalDecoder" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>与えられた <em>encoding</em> の <a class="reference internal" href="../library/codecs.html#codecs.IncrementalDecoder" title="codecs.IncrementalDecoder"><code class="xref py py-class docutils literal"><span class="pre">IncrementalDecoder</span></code></a> オブジェクトを返します。</p>

<dl class="function">

<dt id="c.PyCodec_StreamReader">

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyCodec_StreamReader</code><span class="sig-paren">(</span>const char<em>&nbsp;*encoding</em>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em>&nbsp;*stream</em>, const char<em>&nbsp;*errors</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_StreamReader" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>与えられた <em>encoding</em> の <a class="reference internal" href="../library/codecs.html#codecs.StreamReader" title="codecs.StreamReader"><code class="xref py py-class docutils literal"><span class="pre">StreamReader</span></code></a> ファクトリ関数を返します。</p>

<dl class="function">

<dt id="c.PyCodec_StreamWriter">

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyCodec_StreamWriter</code><span class="sig-paren">(</span>const char<em>&nbsp;*encoding</em>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em>&nbsp;*stream</em>, const char<em>&nbsp;*errors</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_StreamWriter" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>与えられた <em>encoding</em> の <a class="reference internal" href="../library/codecs.html#codecs.StreamWriter" title="codecs.StreamWriter"><code class="xref py py-class docutils literal"><span class="pre">StreamWriter</span></code></a> ファクトリ関数を返します。</p>

<div class="section" id="registry-api-for-unicode-encoding-error-handlers">

<h2>Unicode エラーハンドラ用レジストリ API<a class="headerlink" href="#registry-api-for-unicode-encoding-error-handlers" title="このヘッドラインへのパーマリンク">¶</a></h2>

<dl class="function">

<dt id="c.PyCodec_RegisterError">

int <code class="descname">PyCodec_RegisterError</code><span class="sig-paren">(</span>const char<em>&nbsp;*name</em>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em>&nbsp;*error</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_RegisterError" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>エラーハンドルのためのコールバック関数 <em>error</em> を <em>name</em> で登録します。このコールバック関数は、コーデックがエンコードできない文字/デコードできないバイトに遭遇した時に、そのエンコード/デコード関数の呼び出しで <em>name</em> が指定されていたら呼び出されます。</p>

<p>コールバックは1つの引数として、 <a class="reference internal" href="../library/exceptions.html#UnicodeEncodeError" title="UnicodeEncodeError"><code class="xref py py-exc docutils literal"><span class="pre">UnicodeEncodeError</span></code></a>, <a class="reference internal" href="../library/exceptions.html#UnicodeDecodeError" title="UnicodeDecodeError"><code class="xref py py-exc docutils literal"><span class="pre">UnicodeDecodeError</span></code></a>, <a class="reference internal" href="../library/exceptions.html#UnicodeTranslateError" title="UnicodeTranslateError"><code class="xref py py-exc docutils literal"><span class="pre">UnicodeTranslateError</span></code></a> のどれかのインスタンスを受け取ります。このインスタンスは問題のある文字列やバイト列に関する情報と、その元の文字列中のオフセットを持っています。(その情報を取得するための関数については <a class="reference internal" href="exceptions.html#unicodeexceptions"><span class="std std-ref">Unicode 例外オブジェクト</span></a> を参照してください。) コールバックは渡された例外を発生させるか、2要素のタプルに問題のシーケンスの代替と、 encode/decode を再開する元の文字列中のオフセットとなる整数を格納して返します。</p>

<p>成功したら <code class="docutils literal"><span class="pre">0</span></code> を、エラー時は <code class="docutils literal"><span class="pre">-1</span></code> を返します。</p>

<dl class="function">

<dt id="c.PyCodec_LookupError">

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyCodec_LookupError</code><span class="sig-paren">(</span>const char<em>&nbsp;*name</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_LookupError" title="この定義へのパーマリンク">¶</a></dt>

<dd><p><em>name</em> で登録されたエラーハンドリングコールバック関数を検索します。特別な場合として、<em>NULL</em> が渡された場合、&quot;strict&quot; のエラーハンドリングコールバック関数を返します。</p>

<dl class="function">

<dt id="c.PyCodec_StrictErrors">

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyCodec_StrictErrors</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em>&nbsp;*exc</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_StrictErrors" title="この定義へのパーマリンク">¶</a></dt>

<dd><p><em>exc</em> を例外として発生させます。</p>

<dl class="function">

<dt id="c.PyCodec_IgnoreErrors">

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyCodec_IgnoreErrors</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em>&nbsp;*exc</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_IgnoreErrors" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>unicode エラーを無視し、問題の入力をスキップします。</p>

<dl class="function">

<dt id="c.PyCodec_ReplaceErrors">

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyCodec_ReplaceErrors</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em>&nbsp;*exc</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_ReplaceErrors" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>unicode エラーを <code class="docutils literal"><span class="pre">?</span></code> か <code class="docutils literal"><span class="pre">U+FFFD</span></code> で置き換えます。</p>

<dl class="function">

<dt id="c.PyCodec_XMLCharRefReplaceErrors">

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyCodec_XMLCharRefReplaceErrors</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em>&nbsp;*exc</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_XMLCharRefReplaceErrors" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>unicode encode エラーを XML文字参照で置き換えます。</p>

<dl class="function">

<dt id="c.PyCodec_BackslashReplaceErrors">

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyCodec_BackslashReplaceErrors</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em>&nbsp;*exc</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_BackslashReplaceErrors" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>unicode encode エラーをバックスラッシュエスケープ (<code class="docutils literal"><span class="pre">\x</span></code>, <code class="docutils literal"><span class="pre">\u</span></code>, <code class="docutils literal"><span class="pre">\U</span></code>) で置き換えます。</p>

<dl class="function">

<dt id="c.PyCodec_NameReplaceErrors">

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyCodec_NameReplaceErrors</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em>&nbsp;*exc</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_NameReplaceErrors" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>unicode encode エラーを <code class="docutils literal"><span class="pre">\N{...}</span></code> で置き換えます。</p>

<div class="versionadded">

<p><span class="versionmodified">バージョン 3.5 で追加.</span></p>

</div>

</div>

</div>

<div class="sphinxsidebar" role="navigation" aria-label="main navigation">

<div class="sphinxsidebarwrapper">

<h3><a href="../contents.html">目次</a></h3>

<ul>

<li><a class="reference internal" href="#">codec レジストリとサポート関数</a><ul>

<li><a class="reference internal" href="#codec-lookup-api">コーデック検索API</a></li>

<li><a class="reference internal" href="#registry-api-for-unicode-encoding-error-handlers">Unicode エラーハンドラ用レジストリ API</a></li>

<h4>前のトピックへ</h4>

<p class="topless"><a href="reflection.html"

title="前の章へ">リフレクション</a></p>

<h4>次のトピックへ</h4>

<p class="topless"><a href="abstract.html"

title="次の章へ">抽象オブジェクトレイヤ (abstract objects layer)</a></p>

<div role="note" aria-label="source link">

<h3>このページ</h3>

<ul class="this-page-menu">

<li><a href="../bugs.html">バグ報告</a></li>

<li>

<a href="https://github.com/python/cpython/blob/3.6/Doc/c-api/codec.rst"

rel="nofollow">ソースの表示

</a>

</li>

</ul>

</div>

</div>

</div>

<div class="clearer"></div>

</div>

<div class="related" role="navigation" aria-label="related navigation">

<h3>ナビゲーション</h3>

<ul>

<li class="right" style="margin-right: 10px">

<a href="../genindex.html" title="総索引"

>索引</a></li>

<li class="right" >

<a href="../py-modindex.html" title="Pythonモジュール索引"

>モジュール</a> |</li>

<li class="right" >

<a href="abstract.html" title="抽象オブジェクトレイヤ (abstract objects layer)"

>次へ</a> |</li>

<li class="right" >

<a href="reflection.html" title="リフレクション"

>前へ</a> |</li>

<li><img src="../_static/py.png" alt=""

style="vertical-align: middle; margin-top: -1px"/></li>

<li><a href="https://www.python.org/">Python</a> &#187;</li>

<li>

<span class="version_switcher_placeholder">3.6.5</span>

<a href="../index.html">ドキュメント</a> &#187;

</li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API リファレンスマニュアル</a> &#187;</li>

<li class="nav-item nav-item-2"><a href="utilities.html" >ユーティリティ</a> &#187;</li>

<li class="right">

<div class="inline-search" style="display: none" role="search">

<form class="inline-search" action="../search.html" method="get">

<input placeholder="Quick search" type="text" name="q" />

<input type="submit" value="Go" />

<input type="hidden" name="check_keywords" value="yes" />

<input type="hidden" name="area" value="default" />

</form>

</div>

<script type="text/javascript">$('.inline-search').show(0);</script>

|

</li>

</ul>

</div>

<div class="footer">

&copy; <a href="../copyright.html">Copyright</a> 2001-2018, Python Software Foundation.

<br />

Python Software Foundation は非営利団体です。

<a href="https://www.python.org/psf/donations/">寄付</a>

<br />

最終更新日時: 7月 29, 2018

<a href="../bugs.html">バグを見つけたら</a>?

<br />

このドキュメントは <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.6.5 を使って作成されました。

</div>

</body>