File size: 20,506 Bytes
66b3b8e | 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 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Coding Standards — pgAdmin 4 8.6 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
<script src="_static/documentation_options.js?v=d4c83366"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/sidebar.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Code Snippets" href="code_snippets.html" />
<link rel="prev" title="Code Overview" href="code_overview.html" />
</head><body>
<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="code_snippets.html" title="Code Snippets"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="code_overview.html" title="Code Overview"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="contributions.html" accesskey="U">pgAdmin Project Contributions</a> »</li>
<li class="nav-item nav-item-this"><a href="">Coding Standards</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="coding-standards">
<span id="id1"></span><h1><span class="target" id="index-0"></span>Coding Standards<a class="headerlink" href="#coding-standards" title="Link to this heading">¶</a></h1>
<p>pgAdmin uses multiple technologies and multiple languages, each of which have
their own coding standards.</p>
<section id="general">
<h2>General<a class="headerlink" href="#general" title="Link to this heading">¶</a></h2>
<p>In all languages, indentations should be made with 4 spaces, and excessively long
lines wrapped where appropriate to ensure they can be read on smaller displays
(80 characters is used in many places, but this is not a required maximum size
as it’s quite wasteful on modern displays). Typically lines should not be longer
than 120 characters.</p>
<p>Comments should be included in all code where required to explain its
purpose or how it works if not obvious from a quick review of the code itself.</p>
</section>
<section id="css-3">
<h2>CSS 3<a class="headerlink" href="#css-3" title="Link to this heading">¶</a></h2>
<p>CSS3 is used for styling and layout throughout the application.</p>
<p>Most custom styling comes from individual modules which may advertise static
stylesheets to be included in the module that is loading them via hooks.</p>
<p>Styling overrides (for example, to alter the look and feel) will
typically be found in the <strong>overrides.css</strong> file in the main static file
directory for the application.</p>
<p>Styling should never be applied inline in HTML, always through an external
stylesheet, which should contain comments as appropriate to explain the usage
or purpose for the style.</p>
<p>Styles should be specified clearly, one per line. For example:</p>
<div class="highlight-css notranslate"><div class="highlight"><pre><span></span><span class="c">/* iFrames should have no border */</span>
<span class="nt">iframe</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="k">border-width</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span>
<span class="p">}</span>
<span class="c">/* Ensure the codemirror editor displays full height gutters when resized */</span>
<span class="p">.</span><span class="nc">CodeMirror</span><span class="o">,</span><span class="w"> </span><span class="p">.</span><span class="nc">CodeMirror-gutters</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="k">height</span><span class="p">:</span><span class="w"> </span><span class="mi">100</span><span class="kt">%</span><span class="w"> </span><span class="cp">!important</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
</div>
<p>All stylesheets must be CSS3 compliant.</p>
</section>
<section id="html-5">
<h2>HTML 5<a class="headerlink" href="#html-5" title="Link to this heading">¶</a></h2>
<p>HTML 5 is used for page structure throughout the application, in most cases
being rendered from templates by the Jinja2 template engine in Flask.</p>
<p>All HTML must be HTML 5 compliant.</p>
</section>
<section id="javascript">
<h2>Javascript<a class="headerlink" href="#javascript" title="Link to this heading">¶</a></h2>
<p>Client-side code is written in Javascript using ReactJS and various plugins.
Whilst much of the code is rendered from static files, there is also code that
is rendered from templates using Jinja2 (often to inject the users settings) or
constructed on the fly from module hooks.</p>
<p>A typical Javascript function might be formatted like this (this snipped is from
a template):</p>
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="c1">// Delete a server group</span>
<span class="kd">function</span><span class="w"> </span><span class="nx">delete_server_group</span><span class="p">(</span><span class="nx">item</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nx">alertify</span><span class="p">.</span><span class="nx">confirm</span><span class="p">(</span>
<span class="w"> </span><span class="s1">'Delete server group?'</span><span class="p">,</span>
<span class="w"> </span><span class="s1">'Are you sure you wish to delete the server group "{0}"?'</span><span class="p">.</span><span class="nx">replace</span><span class="p">(</span><span class="s1">'{0}'</span><span class="p">,</span><span class="w"> </span><span class="nx">tree</span><span class="p">.</span><span class="nx">getLabel</span><span class="p">(</span><span class="nx">item</span><span class="p">)),</span>
<span class="w"> </span><span class="kd">function</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nx">id</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">tree</span><span class="p">.</span><span class="nx">getId</span><span class="p">(</span><span class="nx">item</span><span class="p">)</span>
<span class="w"> </span><span class="nx">$</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span><span class="s2">"{{ url_for('NODE-server-group.delete') }}"</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">id</span><span class="o">:</span><span class="w"> </span><span class="nx">id</span><span class="w"> </span><span class="p">})</span>
<span class="w"> </span><span class="p">.</span><span class="nx">done</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">data</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">data</span><span class="p">.</span><span class="nx">success</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mf">0</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nx">report_error</span><span class="p">(</span><span class="nx">data</span><span class="p">.</span><span class="nx">errormsg</span><span class="p">,</span><span class="w"> </span><span class="nx">data</span><span class="p">.</span><span class="nx">info</span><span class="p">);</span>
<span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nx">next</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">tree</span><span class="p">.</span><span class="nx">next</span><span class="p">(</span><span class="nx">item</span><span class="p">);</span>
<span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nx">prev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">tree</span><span class="p">.</span><span class="nx">prev</span><span class="p">(</span><span class="nx">item</span><span class="p">);</span>
<span class="w"> </span><span class="nx">tree</span><span class="p">.</span><span class="nx">remove</span><span class="p">(</span><span class="nx">item</span><span class="p">);</span>
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">next</span><span class="p">.</span><span class="nx">length</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nx">tree</span><span class="p">.</span><span class="nx">select</span><span class="p">(</span><span class="nx">next</span><span class="p">);</span>
<span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">prev</span><span class="p">.</span><span class="nx">length</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nx">tree</span><span class="p">.</span><span class="nx">select</span><span class="p">(</span><span class="nx">prev</span><span class="p">);</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">)</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="kc">null</span>
<span class="w"> </span><span class="p">)</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Note the use of a descriptive function name, using the underscore character to
separate words in all lower case, and short but descriptive lower case variable
names.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>From version 3.0 onwards, new or refactored code should be written using
ES6 features and conventions.</p>
</div>
</section>
<section id="python">
<h2>Python<a class="headerlink" href="#python" title="Link to this heading">¶</a></h2>
<p>Python is used for the backend web server. All code must be compatible with
Python 2.7 and should include PyDoc comments whilst following the official
Python coding standards defined in
<a class="reference external" href="https://www.python.org/dev/peps/pep-0008/">PEP 8</a>. An example function along
with the required file header is shown below:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1">##########################################################################</span>
<span class="c1">#</span>
<span class="c1"># pgAdmin 4 - PostgreSQL Tools</span>
<span class="c1">#</span>
<span class="c1"># Copyright (C) 2013 - 2024, The pgAdmin Development Team</span>
<span class="c1"># This software is released under the PostgreSQL Licence</span>
<span class="c1">#</span>
<span class="c1">##########################################################################</span>
<span class="sd">"""Integration hooks for server groups."""</span>
<span class="kn">from</span> <span class="nn">flask</span> <span class="kn">import</span> <span class="n">render_template</span><span class="p">,</span> <span class="n">url_for</span>
<span class="kn">from</span> <span class="nn">flask.ext.security</span> <span class="kn">import</span> <span class="n">current_user</span>
<span class="kn">from</span> <span class="nn">pgadmin.settings.settings_model</span> <span class="kn">import</span> <span class="n">db</span><span class="p">,</span> <span class="n">ServerGroup</span>
<span class="k">def</span> <span class="nf">get_nodes</span><span class="p">():</span>
<span class="w"> </span><span class="sd">"""Return a JSON document listing the server groups for the user"""</span>
<span class="n">groups</span> <span class="o">=</span> <span class="n">ServerGroup</span><span class="o">.</span><span class="n">query</span><span class="o">.</span><span class="n">filter_by</span><span class="p">(</span><span class="n">user_id</span><span class="o">=</span><span class="n">current_user</span><span class="o">.</span><span class="n">id</span><span class="p">)</span>
<span class="n">value</span> <span class="o">=</span> <span class="s1">''</span>
<span class="k">for</span> <span class="n">group</span> <span class="ow">in</span> <span class="n">groups</span><span class="p">:</span>
<span class="n">value</span> <span class="o">+=</span> <span class="s1">'{"id":</span><span class="si">%d</span><span class="s1">,"label":"</span><span class="si">%s</span><span class="s1">","icon":"icon-server-group","inode":true},'</span> \
<span class="o">%</span> <span class="p">(</span><span class="n">group</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="n">group</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="k">return</span> <span class="n">value</span>
</pre></div>
</div>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Coding Standards</a><ul>
<li><a class="reference internal" href="#general">General</a></li>
<li><a class="reference internal" href="#css-3">CSS 3</a></li>
<li><a class="reference internal" href="#html-5">HTML 5</a></li>
<li><a class="reference internal" href="#javascript">Javascript</a></li>
<li><a class="reference internal" href="#python">Python</a></li>
</ul>
</li>
</ul>
</div>
<h3><a href="index.html">Table of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="submitting_pull_requests.html">Submitting Pull Requests</a></li>
<li class="toctree-l2"><a class="reference internal" href="code_overview.html">Code Overview</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Coding Standards</a></li>
<li class="toctree-l2"><a class="reference internal" href="code_snippets.html">Code Snippets</a></li>
<li class="toctree-l2"><a class="reference internal" href="code_review.html">Code Review Notes</a></li>
<li class="toctree-l2"><a class="reference internal" href="translations.html">Translations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
</ul>
<search 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>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
<div id="sidebarbutton" title="Collapse sidebar">
<span>«</span>
</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="code_snippets.html" title="Code Snippets"
>next</a> |</li>
<li class="right" >
<a href="code_overview.html" title="Code Overview"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="contributions.html" >pgAdmin Project Contributions</a> »</li>
<li class="nav-item nav-item-this"><a href="">Coding Standards</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
<div class="related" role="navigation" aria-label="related navigation">
<ul>
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
<li class="right" ><a href="code_snippets.html" title="Code Snippets" accesskey="N">next</a> |</li>
<li class="right" ><a href="code_overview.html" title="Code Overview" accesskey="P">previous</a> |</li>
</ul>
</div>
</div>
</body>
</html> |