Gecko [ v99win.today ]

Name	Size	Permission
abstract.html	7.8 KB	-rw-r--r--
allocation.html	24.04 KB	-rw-r--r--
arg.html	64.25 KB	-rw-r--r--
bool.html	11.44 KB	-rw-r--r--
buffer.html	58.49 KB	-rw-r--r--
bytearray.html	18.39 KB	-rw-r--r--
capsule.html	26.78 KB	-rw-r--r--
cell.html	13.74 KB	-rw-r--r--
class.html	14.3 KB	-rw-r--r--
cobject.html	15.67 KB	-rw-r--r--
code.html	15.57 KB	-rw-r--r--
codec.html	29.28 KB	-rw-r--r--
complex.html	25.03 KB	-rw-r--r--
concrete.html	15.93 KB	-rw-r--r--
conversion.html	29.24 KB	-rw-r--r--
datetime.html	35.92 KB	-rw-r--r--
descriptor.html	15.74 KB	-rw-r--r--
dict.html	42.03 KB	-rw-r--r--
exceptions.html	112.66 KB	-rw-r--r--
file.html	28.8 KB	-rw-r--r--
float.html	21.5 KB	-rw-r--r--
function.html	17.69 KB	-rw-r--r--
gcsupport.html	29.5 KB	-rw-r--r--
gen.html	9.84 KB	-rw-r--r--
import.html	43.14 KB	-rw-r--r--
index.html	13.69 KB	-rw-r--r--
init.html	122.91 KB	-rw-r--r--
int.html	24.28 KB	-rw-r--r--
intro.html	57.73 KB	-rw-r--r--
iter.html	11.38 KB	-rw-r--r--
iterator.html	13.32 KB	-rw-r--r--
list.html	31.45 KB	-rw-r--r--
long.html	39.54 KB	-rw-r--r--
mapping.html	20.85 KB	-rw-r--r--
marshal.html	18.82 KB	-rw-r--r--
memory.html	37.51 KB	-rw-r--r--
method.html	16.77 KB	-rw-r--r--
module.html	21.95 KB	-rw-r--r--
none.html	8.76 KB	-rw-r--r--
number.html	64.95 KB	-rw-r--r--
objbuffer.html	14.62 KB	-rw-r--r--
object.html	74.9 KB	-rw-r--r--
objimpl.html	7.59 KB	-rw-r--r--
refcounting.html	14.46 KB	-rw-r--r--
reflection.html	12.81 KB	-rw-r--r--
sequence.html	41.73 KB	-rw-r--r--
set.html	35.44 KB	-rw-r--r--
slice.html	16.89 KB	-rw-r--r--
string.html	46.73 KB	-rw-r--r--
structures.html	41.96 KB	-rw-r--r--
sys.html	26.72 KB	-rw-r--r--
tuple.html	27.17 KB	-rw-r--r--
type.html	19.18 KB	-rw-r--r--
typeobj.html	209.91 KB	-rw-r--r--
unicode.html	160.87 KB	-rw-r--r--
utilities.html	7.88 KB	-rw-r--r--
veryhigh.html	66.91 KB	-rw-r--r--
weakref.html	15.68 KB	-rw-r--r--

Code Editor : file.html

<!DOCTYPE html>

<title>File Objects &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="Module Objects" href="module.html" />
 <link rel="prev" title="Method Objects" href="method.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/c-api/file.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/c-api/file.html"> Python documentation for the Python3 version packaged in this release</a>.
</div>
 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="module.html" title="Module Objects"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="method.html" title="Method Objects"
 accesskey="P">previous</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>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="concrete.html" accesskey="U">Concrete Objects Layer</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">File Objects</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="file-objects">
<h1>File Objects<a class="headerlink" href="#file-objects" title="Permalink to this headline">¶</a></h1>
Python’s built-in file objects are implemented entirely on the <code class="xref c c-type docutils literal notranslate">FILE*</code>
support from the C standard library. This is an implementation detail and may
change in future releases of Python.
<dl class="c type">
<dt class="sig sig-object c" id="c.PyFileObject">
type PyFileObject<a class="headerlink" href="#c.PyFileObject" title="Permalink to this definition">¶</a> </dt>
<dd>This subtype of <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><code class="xref c c-type docutils literal notranslate">PyObject</code></a> represents a Python file object.
</dd></dl>

<dl class="c var">
<dt class="sig sig-object c" id="c.PyFile_Type">
<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> PyFile_Type<a class="headerlink" href="#c.PyFile_Type" title="Permalink to this definition">¶</a> </dt>
<dd>This instance of <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject"><code class="xref c c-type docutils literal notranslate">PyTypeObject</code></a> represents the Python file type. This is
exposed to Python programs as <code class="docutils literal notranslate">file</code> and <code class="docutils literal notranslate">types.FileType</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFile_Check">
int PyFile_Check(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p)<a class="headerlink" href="#c.PyFile_Check" title="Permalink to this definition">¶</a> </dt>
<dd>Return true if its argument is a <a class="reference internal" href="#c.PyFileObject" title="PyFileObject"><code class="xref c c-type docutils literal notranslate">PyFileObject</code></a> or a subtype of
<a class="reference internal" href="#c.PyFileObject" title="PyFileObject"><code class="xref c c-type docutils literal notranslate">PyFileObject</code></a>.
<div class="versionchanged">
Changed in version 2.2: Allowed subtypes to be accepted.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFile_CheckExact">
int PyFile_CheckExact(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p)<a class="headerlink" href="#c.PyFile_CheckExact" title="Permalink to this definition">¶</a> </dt>
<dd>Return true if its argument is a <a class="reference internal" href="#c.PyFileObject" title="PyFileObject"><code class="xref c c-type docutils literal notranslate">PyFileObject</code></a>, but not a subtype of
<a class="reference internal" href="#c.PyFileObject" title="PyFileObject"><code class="xref c c-type docutils literal notranslate">PyFileObject</code></a>.
<div class="versionadded">
New in version 2.2.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFile_FromString">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyFile_FromString(char *filename, char *mode)<a class="headerlink" href="#c.PyFile_FromString" title="Permalink to this definition">¶</a> </dt>
<dd>On success, return a new file object that is opened on the file given by
filename, with a file mode given by mode, where mode has the same
semantics as the standard C routine <code class="xref c c-func docutils literal notranslate">fopen()</code>. On failure, return NULL.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFile_FromFile">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyFile_FromFile(FILE *fp, char *name, char *mode, int (*close)(FILE*))<a class="headerlink" href="#c.PyFile_FromFile" title="Permalink to this definition">¶</a> </dt>
<dd>Create a new <a class="reference internal" href="#c.PyFileObject" title="PyFileObject"><code class="xref c c-type docutils literal notranslate">PyFileObject</code></a> from the already-open standard C file
pointer, fp. The function close will be called when the file should be
closed. Return NULL and close the file using close on failure.
close is optional and can be set to NULL.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c">
FILE* PyFile_AsFile(PyObject \*p)</dt>
<dd>Return the file object associated with p as a <code class="xref c c-type docutils literal notranslate">FILE*</code>.
If the caller will ever use the returned <code class="xref c c-type docutils literal notranslate">FILE*</code> object while
the <a class="reference internal" href="../glossary.html#term-GIL">GIL</a> is released it must also call the <code class="xref c c-func docutils literal notranslate">PyFile_IncUseCount()</code> and
<code class="xref c c-func docutils literal notranslate">PyFile_DecUseCount()</code> functions described below as appropriate.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c">
void PyFile_IncUseCount(PyFileObject \*p)</dt>
<dd>Increments the PyFileObject’s internal use count to indicate
that the underlying <code class="xref c c-type docutils literal notranslate">FILE*</code> is being used.
This prevents Python from calling f_close() on it from another thread.
Callers of this must call <code class="xref c c-func docutils literal notranslate">PyFile_DecUseCount()</code> when they are
finished with the <code class="xref c c-type docutils literal notranslate">FILE*</code>. Otherwise the file object will
never be closed by Python.
The <a class="reference internal" href="../glossary.html#term-GIL">GIL</a> must be held while calling this function.
The suggested use is to call this after <code class="xref c c-func docutils literal notranslate">PyFile_AsFile()</code> and before
you release the GIL:
<div class="highlight-default notranslate"><div class="highlight"><pre>FILE *fp = PyFile_AsFile(p);
PyFile_IncUseCount(p);
/* ... */
Py_BEGIN_ALLOW_THREADS
do_something(fp);
Py_END_ALLOW_THREADS
/* ... */
PyFile_DecUseCount(p);
</pre></div>
</div>
<div class="versionadded">
New in version 2.6.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c">
void PyFile_DecUseCount(PyFileObject \*p)</dt>
<dd>Decrements the PyFileObject’s internal unlocked_count member to
indicate that the caller is done with its own use of the <code class="xref c c-type docutils literal notranslate">FILE*</code>.
This may only be called to undo a prior call to <code class="xref c c-func docutils literal notranslate">PyFile_IncUseCount()</code>.
The <a class="reference internal" href="../glossary.html#term-GIL">GIL</a> must be held while calling this function (see the example
above).
<div class="versionadded">
New in version 2.6.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFile_GetLine">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyFile_GetLine(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p, int n)<a class="headerlink" href="#c.PyFile_GetLine" title="Permalink to this definition">¶</a> </dt>
<dd>Equivalent to <code class="docutils literal notranslate">p.readline([n])</code>, this function reads one line from the
object p. p may be a file object or any object with a
<a class="reference internal" href="../library/io.html#io.IOBase.readline" title="io.IOBase.readline"><code class="xref py py-meth docutils literal notranslate">readline()</code></a>
method. If n is <code class="docutils literal notranslate">0</code>, exactly one line is read, regardless of the length of
the line. If n is greater than <code class="docutils literal notranslate">0</code>, no more than n bytes will be read
from the file; a partial line can be returned. In both cases, an empty string
is returned if the end of the file is reached immediately. If n is less than
<code class="docutils literal notranslate">0</code>, however, one line is read regardless of length, but <code class="xref py py-exc docutils literal notranslate">EOFError</code> is
raised if the end of the file is reached immediately.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFile_Name">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyFile_Name(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p)<a class="headerlink" href="#c.PyFile_Name" title="Permalink to this definition">¶</a> </dt>
<dd>Return the name of the file specified by p as a string object.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFile_SetBufSize">
void PyFile_SetBufSize(<a class="reference internal" href="#c.PyFileObject" title="PyFileObject">PyFileObject</a> *p, int n)<a class="headerlink" href="#c.PyFile_SetBufSize" title="Permalink to this definition">¶</a> </dt>
<dd>Available on systems with <code class="xref c c-func docutils literal notranslate">setvbuf()</code> only. This should only be called
immediately after file object creation.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFile_SetEncoding">
int PyFile_SetEncoding(<a class="reference internal" href="#c.PyFileObject" title="PyFileObject">PyFileObject</a> *p, const char *enc)<a class="headerlink" href="#c.PyFile_SetEncoding" title="Permalink to this definition">¶</a> </dt>
<dd>Set the file’s encoding for Unicode output to enc. Return <code class="docutils literal notranslate">1</code> on success and <code class="docutils literal notranslate">0</code>
on failure.
<div class="versionadded">
New in version 2.3.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c">
int PyFile_SetEncodingAndErrors(PyFileObject *p, const char *enc, *errors)</dt>
<dd>Set the file’s encoding for Unicode output to enc, and its error
mode to err. Return <code class="docutils literal notranslate">1</code> on success and <code class="docutils literal notranslate">0</code> on failure.
<div class="versionadded">
New in version 2.6.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFile_SoftSpace">
int PyFile_SoftSpace(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p, int newflag)<a class="headerlink" href="#c.PyFile_SoftSpace" title="Permalink to this definition">¶</a> </dt>
<dd>This function exists for internal use by the interpreter. Set the
<code class="xref py py-attr docutils literal notranslate">softspace</code> attribute of p to newflag and return the previous value.
p does not have to be a file object for this function to work properly; any
object is supported (thought its only interesting if the <code class="xref py py-attr docutils literal notranslate">softspace</code>
attribute can be set). This function clears any errors, and will return <code class="docutils literal notranslate">0</code>
as the previous value if the attribute either does not exist or if there were
errors in retrieving it. There is no way to detect errors from this function,
but doing so should not be needed.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFile_WriteObject">
int PyFile_WriteObject(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *obj, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p, int flags)<a class="headerlink" href="#c.PyFile_WriteObject" title="Permalink to this definition">¶</a> </dt>
<dd>Write object obj to file object p. The only supported flag for flags is
<code class="xref py py-const docutils literal notranslate">Py_PRINT_RAW</code>; if given, the <a class="reference internal" href="../library/functions.html#str" title="str"><code class="xref py py-func docutils literal notranslate">str()</code></a> of the object is written
instead of the <a class="reference internal" href="../library/functions.html#repr" title="repr"><code class="xref py py-func docutils literal notranslate">repr()</code></a>. Return <code class="docutils literal notranslate">0</code> on success or <code class="docutils literal notranslate">-1</code> on failure; the
appropriate exception will be set.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFile_WriteString">
int PyFile_WriteString(const char *s, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p)<a class="headerlink" href="#c.PyFile_WriteString" title="Permalink to this definition">¶</a> </dt>
<dd>Write string s to file object p. Return <code class="docutils literal notranslate">0</code> on success or <code class="docutils literal notranslate">-1</code> on
failure; the appropriate exception will be set.
</dd></dl>

</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h4>Previous topic</h4>
 <a href="method.html"
 title="previous chapter">Method Objects</a>
 <h4>Next topic</h4>
 <a href="module.html"
 title="next chapter">Module Objects</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/c-api/file.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="module.html" title="Module Objects"
 >next</a> |</li>
 <li class="right" >
 <a href="method.html" title="Method Objects"
 >previous</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>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="concrete.html" >Concrete Objects Layer</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">File Objects</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on December 09, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : file.html