/usr/share/doc/python3-postgresql/html/_modules/postgresql.html is in python3-postgresql 1.1.0-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>postgresql — py-postgresql 1.1.0 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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>
<link rel="top" title="py-postgresql 1.1.0 documentation" href="../index.html" />
<link rel="up" title="Module code" href="index.html" />
<link rel="stylesheet" href="_static/unsuck.css" type="text/css" />
</head>
<body>
<div class="related">
<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><a href="../index.html">py-postgresql 1.1.0 documentation</a> »</li>
<li><a href="index.html" accesskey="U">Module code</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for postgresql</h1><div class="highlight"><pre>
<span class="c">##</span>
<span class="c"># py-postgresql root package</span>
<span class="c"># http://python.projects.postgresql.org</span>
<span class="c">##</span>
<span class="sd">"""</span>
<span class="sd">py-postgresql is a Python package for using PostgreSQL. This includes low-level</span>
<span class="sd">protocol tools, a driver(PG-API and DB-API), and cluster management tools.</span>
<span class="sd">If it's not documented in the narratives, `postgresql.documentation.index`, then</span>
<span class="sd">the stability of the APIs should *not* be trusted.</span>
<span class="sd">See <http://postgresql.org> for more information about PostgreSQL.</span>
<span class="sd">"""</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
<span class="s">'__author__'</span><span class="p">,</span>
<span class="s">'__date__'</span><span class="p">,</span>
<span class="s">'__version__'</span><span class="p">,</span>
<span class="s">'__docformat__'</span><span class="p">,</span>
<span class="s">'version'</span><span class="p">,</span>
<span class="s">'version_info'</span><span class="p">,</span>
<span class="s">'open'</span><span class="p">,</span>
<span class="p">]</span>
<span class="c">#: The version string of py-postgresql.</span>
<span class="n">version</span> <span class="o">=</span> <span class="s">''</span> <span class="c"># overridden by subsequent import from .project.</span>
<span class="c">#: The version triple of py-postgresql: (major, minor, patch).</span>
<span class="n">version_info</span> <span class="o">=</span> <span class="p">()</span> <span class="c"># overridden by subsequent import from .project.</span>
<span class="c"># Optional.</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">.project</span> <span class="kn">import</span> <span class="n">version_info</span><span class="p">,</span> <span class="n">version</span><span class="p">,</span> \
<span class="n">author</span> <span class="k">as</span> <span class="n">__author__</span><span class="p">,</span> <span class="n">date</span> <span class="k">as</span> <span class="n">__date__</span>
<span class="n">__version__</span> <span class="o">=</span> <span class="n">version</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="c"># Avoid importing these until requested.</span>
<span class="n">_pg_iri</span> <span class="o">=</span> <span class="n">_pg_driver</span> <span class="o">=</span> <span class="n">_pg_param</span> <span class="o">=</span> <span class="bp">None</span>
<div class="viewcode-block" id="open"><a class="viewcode-back" href="../reference.html#postgresql.open">[docs]</a><span class="k">def</span> <span class="nf">open</span><span class="p">(</span><span class="n">iri</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">prompt_title</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Create a `postgresql.api.Connection` to the server referenced by the given</span>
<span class="sd"> `iri`::</span>
<span class="sd"> >>> import postgresql</span>
<span class="sd"> # General Format:</span>
<span class="sd"> >>> db = postgresql.open('pq://user:password@host:port/database')</span>
<span class="sd"> # Connect to 'postgres' at localhost.</span>
<span class="sd"> >>> db = postgresql.open('localhost/postgres')</span>
<span class="sd"> Connection keywords can also be used with `open`. See the narratives for</span>
<span class="sd"> more information.</span>
<span class="sd"> The `prompt_title` keyword is ignored. `open` will never prompt for</span>
<span class="sd"> the password unless it is explicitly instructed to do so.</span>
<span class="sd"> (Note: "pq" is the name of the protocol used to communicate with PostgreSQL)</span>
<span class="sd"> """</span>
<span class="k">global</span> <span class="n">_pg_iri</span><span class="p">,</span> <span class="n">_pg_driver</span><span class="p">,</span> <span class="n">_pg_param</span>
<span class="k">if</span> <span class="n">_pg_iri</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">iri</span> <span class="k">as</span> <span class="n">_pg_iri</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">driver</span> <span class="k">as</span> <span class="n">_pg_driver</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">clientparameters</span> <span class="k">as</span> <span class="n">_pg_param</span>
<span class="n">return_connector</span> <span class="o">=</span> <span class="bp">False</span>
<span class="k">if</span> <span class="n">iri</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">if</span> <span class="n">iri</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">'&'</span><span class="p">):</span>
<span class="n">return_connector</span> <span class="o">=</span> <span class="bp">True</span>
<span class="n">iri</span> <span class="o">=</span> <span class="n">iri</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="n">iri_params</span> <span class="o">=</span> <span class="n">_pg_iri</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">iri</span><span class="p">)</span>
<span class="n">iri_params</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s">'path'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">iri_params</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">std_params</span> <span class="o">=</span> <span class="n">_pg_param</span><span class="o">.</span><span class="n">collect</span><span class="p">(</span><span class="n">prompt_title</span> <span class="o">=</span> <span class="bp">None</span><span class="p">)</span>
<span class="c"># If unix is specified, it's going to conflict with any standard</span>
<span class="c"># settings, so remove them right here.</span>
<span class="k">if</span> <span class="s">'unix'</span> <span class="ow">in</span> <span class="n">kw</span> <span class="ow">or</span> <span class="s">'unix'</span> <span class="ow">in</span> <span class="n">iri_params</span><span class="p">:</span>
<span class="n">std_params</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s">'host'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="n">std_params</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s">'port'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="n">params</span> <span class="o">=</span> <span class="n">_pg_param</span><span class="o">.</span><span class="n">normalize</span><span class="p">(</span>
<span class="nb">list</span><span class="p">(</span><span class="n">_pg_param</span><span class="o">.</span><span class="n">denormalize_parameters</span><span class="p">(</span><span class="n">std_params</span><span class="p">))</span> <span class="o">+</span> \
<span class="nb">list</span><span class="p">(</span><span class="n">_pg_param</span><span class="o">.</span><span class="n">denormalize_parameters</span><span class="p">(</span><span class="n">iri_params</span><span class="p">))</span> <span class="o">+</span> \
<span class="nb">list</span><span class="p">(</span><span class="n">_pg_param</span><span class="o">.</span><span class="n">denormalize_parameters</span><span class="p">(</span><span class="n">kw</span><span class="p">))</span>
<span class="p">)</span>
<span class="n">_pg_param</span><span class="o">.</span><span class="n">resolve_password</span><span class="p">(</span><span class="n">params</span><span class="p">)</span>
<span class="n">C</span> <span class="o">=</span> <span class="n">_pg_driver</span><span class="o">.</span><span class="n">default</span><span class="o">.</span><span class="n">fit</span><span class="p">(</span><span class="o">**</span><span class="n">params</span><span class="p">)</span>
<span class="k">if</span> <span class="n">return_connector</span> <span class="ow">is</span> <span class="bp">True</span><span class="p">:</span>
<span class="k">return</span> <span class="n">C</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">c</span> <span class="o">=</span> <span class="n">C</span><span class="p">()</span>
<span class="n">c</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span>
<span class="k">return</span> <span class="n">c</span>
</div>
<span class="n">__docformat__</span> <span class="o">=</span> <span class="s">'reStructuredText'</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input 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>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<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><a href="../index.html">py-postgresql 1.1.0 documentation</a> »</li>
<li><a href="index.html" >Module code</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright Python+Postgres.
Last updated on Mar 31, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>
|