mirror of
https://github.com/element-hq/synapse.git
synced 2024-12-01 07:59:15 +03:00
324 lines
28 KiB
HTML
324 lines
28 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en" class="sidebar-visible no-js light">
|
||
|
|
<head>
|
||
|
|
<!-- Book generated using mdBook -->
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>Code Style - Synapse</title>
|
||
|
|
<!-- Custom HTML head -->
|
||
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||
|
|
<meta name="description" content="">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<meta name="theme-color" content="#ffffff" />
|
||
|
|
|
||
|
|
<link rel="icon" href="favicon.svg">
|
||
|
|
<link rel="shortcut icon" href="favicon.png">
|
||
|
|
<link rel="stylesheet" href="css/variables.css">
|
||
|
|
<link rel="stylesheet" href="css/general.css">
|
||
|
|
<link rel="stylesheet" href="css/chrome.css">
|
||
|
|
<link rel="stylesheet" href="css/print.css" media="print">
|
||
|
|
<!-- Fonts -->
|
||
|
|
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
|
||
|
|
<link rel="stylesheet" href="fonts/fonts.css">
|
||
|
|
<!-- Highlight.js Stylesheets -->
|
||
|
|
<link rel="stylesheet" href="highlight.css">
|
||
|
|
<link rel="stylesheet" href="tomorrow-night.css">
|
||
|
|
<link rel="stylesheet" href="ayu-highlight.css">
|
||
|
|
|
||
|
|
<!-- Custom theme stylesheets -->
|
||
|
|
<link rel="stylesheet" href="docs/website_files/table-of-contents.css">
|
||
|
|
<link rel="stylesheet" href="docs/website_files/remove-nav-buttons.css">
|
||
|
|
<link rel="stylesheet" href="docs/website_files/indent-section-headers.css">
|
||
|
|
<link rel="stylesheet" href="docs/website_files/version-picker.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!-- Provide site root to javascript -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var path_to_root = "";
|
||
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
try {
|
||
|
|
var theme = localStorage.getItem('mdbook-theme');
|
||
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
||
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||
|
|
}
|
||
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||
|
|
}
|
||
|
|
} catch (e) { }
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var theme;
|
||
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
|
|
var html = document.querySelector('html');
|
||
|
|
html.classList.remove('no-js')
|
||
|
|
html.classList.remove('light')
|
||
|
|
html.classList.add(theme);
|
||
|
|
html.classList.add('js');
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var html = document.querySelector('html');
|
||
|
|
var sidebar = 'hidden';
|
||
|
|
if (document.body.clientWidth >= 1080) {
|
||
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
|
|
sidebar = sidebar || 'visible';
|
||
|
|
}
|
||
|
|
html.classList.remove('sidebar-visible');
|
||
|
|
html.classList.add("sidebar-" + sidebar);
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
||
|
|
<div class="sidebar-scrollbox">
|
||
|
|
<ol class="chapter"><li class="chapter-item expanded affix "><li class="part-title">Introduction</li><li class="chapter-item expanded "><a href="welcome_and_overview.html">Welcome and Overview</a></li><li class="chapter-item expanded affix "><li class="part-title">Setup</li><li class="chapter-item expanded "><a href="setup/installation.html">Installation</a></li><li class="chapter-item expanded "><a href="postgres.html">Using Postgres</a></li><li class="chapter-item expanded "><a href="reverse_proxy.html">Configuring a Reverse Proxy</a></li><li class="chapter-item expanded "><a href="setup/forward_proxy.html">Configuring a Forward/Outbound Proxy</a></li><li class="chapter-item expanded "><a href="turn-howto.html">Configuring a Turn Server</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="setup/turn/coturn.html">coturn TURN server</a></li><li class="chapter-item expanded "><a href="setup/turn/eturnal.html">eturnal TURN server</a></li></ol></li><li class="chapter-item expanded "><a href="delegate.html">Delegation</a></li><li class="chapter-item expanded affix "><li class="part-title">Upgrading</li><li class="chapter-item expanded "><a href="upgrade.html">Upgrading between Synapse Versions</a></li><li class="chapter-item expanded affix "><li class="part-title">Usage</li><li class="chapter-item expanded "><a href="federate.html">Federation</a></li><li class="chapter-item expanded "><a href="usage/configuration/index.html">Configuration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="usage/configuration/config_documentation.html">Configuration Manual</a></li><li class="chapter-item expanded "><a href="usage/configuration/homeserver_sample_config.html">Homeserver Sample Config File</a></li><li class="chapter-item expanded "><a href="usage/configuration/logging_sample_config.html">Logging Sample Config File</a></li><li class="chapter-item expanded "><a href="structured_logging.html">Structured Logging</a></li><li class="chapter-item expanded "><a href="templates.html">Templates</a></li><li class="chapter-item expanded "><a href="usage/configuration/user_authentication/index.html">User Authentication</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="usage/configuration/user_authentication/single_sign_on/index.html">Single-Sign On</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="openid.html">OpenID Connect</a></li><li class="chapter-item expanded "><a href="usage/configuration/user_authentication/single_sign_on/saml.html">SAML</a></li><li class="chapter-item expanded "><a href="usage/configuration/user_authentication/single_sign_on/cas.html">CAS</a></li><li class="chapter-item expanded "><a href="sso_mapping_providers.html">SSO Mapping Providers</a></li></ol></li><li class="chapter-item expanded "><a href="password_auth_providers.html">Password Auth Providers</a></li><li class="chapter-item expanded "><a href="jwt.html">JSON Web Tokens</a></li><li class="chapter-item expanded "><a href="usage/configuration/user_authentication/refresh_tokens.html">Refresh Tokens</a></li></ol></li><li class="chapter-item expanded "><a href="CAPTCHA_SETUP.html">Registration Captcha</a></li><li class="chapter-item expanded "><a href="application_services.html">Application Services</a></li><li class="chapter-item expanded "><a href="server_notices.html">Server Notices</a></li><li class="chapter-item expanded "><a href="consent_tracking.html">Consent Tracking</a></li><li class="chapter-item expanded "><a href="user_directory.html">User Directory</a></li><li class="chapter-item expanded "><a href="message_retention_policies.html">Message Retention Policies</a></li><li class="chapter-item expanded "><a href="modules/index.html">Pluggable Modules</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="modules/writing_a_module.html">Writing a module</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="modules/spam_checker_callbacks.html">Spam checker callbacks</a></li><li class="chapter-item
|
||
|
|
</div>
|
||
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div id="page-wrapper" class="page-wrapper">
|
||
|
|
|
||
|
|
<div class="page">
|
||
|
|
<div id="menu-bar-hover-placeholder"></div>
|
||
|
|
<div id="menu-bar" class="menu-bar sticky bordered">
|
||
|
|
<div class="left-buttons">
|
||
|
|
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
||
|
|
<i class="fa fa-bars"></i>
|
||
|
|
</button>
|
||
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
||
|
|
<i class="fa fa-paint-brush"></i>
|
||
|
|
</button>
|
||
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
||
|
|
</ul>
|
||
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
||
|
|
<i class="fa fa-search"></i>
|
||
|
|
</button>
|
||
|
|
<div class="version-picker">
|
||
|
|
<div class="dropdown">
|
||
|
|
<div class="select">
|
||
|
|
<span></span>
|
||
|
|
<i class="fa fa-chevron-down"></i>
|
||
|
|
</div>
|
||
|
|
<input type="hidden" name="version">
|
||
|
|
<ul class="dropdown-menu">
|
||
|
|
<!-- Versions will be added dynamically in version-picker.js -->
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h1 class="menu-title">Synapse</h1>
|
||
|
|
|
||
|
|
<div class="right-buttons">
|
||
|
|
<a href="print.html" title="Print this book" aria-label="Print this book">
|
||
|
|
<i id="print-button" class="fa fa-print"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository">
|
||
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/element-hq/synapse/edit/develop/docs/code_style.md" title="Suggest an edit" aria-label="Suggest an edit">
|
||
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="search-wrapper" class="hidden">
|
||
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
||
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
||
|
|
</form>
|
||
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
||
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
||
|
|
<ul id="searchresults">
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
||
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<div id="content" class="content">
|
||
|
|
<main>
|
||
|
|
<!-- Page table of contents -->
|
||
|
|
<div class="sidetoc">
|
||
|
|
<nav class="pagetoc"></nav>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h1 id="code-style"><a class="header" href="#code-style">Code Style</a></h1>
|
||
|
|
<h2 id="formatting-tools"><a class="header" href="#formatting-tools">Formatting tools</a></h2>
|
||
|
|
<p>The Synapse codebase uses a number of code formatting tools in order to
|
||
|
|
quickly and automatically check for formatting (and sometimes logical)
|
||
|
|
errors in code.</p>
|
||
|
|
<p>The necessary tools are:</p>
|
||
|
|
<ul>
|
||
|
|
<li><a href="https://black.readthedocs.io/en/stable/">black</a>, a source code formatter;</li>
|
||
|
|
<li><a href="https://pycqa.github.io/isort/">isort</a>, which organises each file's imports;</li>
|
||
|
|
<li><a href="https://github.com/charliermarsh/ruff">ruff</a>, which can spot common errors; and</li>
|
||
|
|
<li><a href="https://mypy.readthedocs.io/en/stable/">mypy</a>, a type checker.</li>
|
||
|
|
</ul>
|
||
|
|
<p>See <a href="development/contributing_guide.html#run-the-linters">the contributing guide</a> for instructions
|
||
|
|
on how to install the above tools and run the linters.</p>
|
||
|
|
<p>It's worth noting that modern IDEs and text editors can run these tools
|
||
|
|
automatically on save. It may be worth looking into whether this
|
||
|
|
functionality is supported in your editor for a more convenient
|
||
|
|
development workflow. It is not, however, recommended to run <code>mypy</code>
|
||
|
|
on save as it takes a while and can be very resource intensive.</p>
|
||
|
|
<h2 id="general-rules"><a class="header" href="#general-rules">General rules</a></h2>
|
||
|
|
<ul>
|
||
|
|
<li><strong>Naming</strong>:
|
||
|
|
<ul>
|
||
|
|
<li>Use <code>CamelCase</code> for class and type names</li>
|
||
|
|
<li>Use underscores for <code>function_names</code> and <code>variable_names</code>.</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><strong>Docstrings</strong>: should follow the <a href="https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings">google code
|
||
|
|
style</a>.
|
||
|
|
See the
|
||
|
|
<a href="http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html">examples</a>
|
||
|
|
in the sphinx documentation.</li>
|
||
|
|
<li><strong>Imports</strong>:
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<p>Imports should be sorted by <code>isort</code> as described above.</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p>Prefer to import classes and functions rather than packages or
|
||
|
|
modules.</p>
|
||
|
|
<p>Example:</p>
|
||
|
|
<pre><code class="language-python">from synapse.types import UserID
|
||
|
|
...
|
||
|
|
user_id = UserID(local, server)
|
||
|
|
</code></pre>
|
||
|
|
<p>is preferred over:</p>
|
||
|
|
<pre><code class="language-python">from synapse import types
|
||
|
|
...
|
||
|
|
user_id = types.UserID(local, server)
|
||
|
|
</code></pre>
|
||
|
|
<p>(or any other variant).</p>
|
||
|
|
<p>This goes against the advice in the Google style guide, but it
|
||
|
|
means that errors in the name are caught early (at import time).</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p>Avoid wildcard imports (<code>from synapse.types import *</code>) and
|
||
|
|
relative imports (<code>from .types import UserID</code>).</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h2 id="configuration-code-and-documentation-format"><a class="header" href="#configuration-code-and-documentation-format">Configuration code and documentation format</a></h2>
|
||
|
|
<p>When adding a configuration option to the code, if several settings are grouped into a single dict, ensure that your code
|
||
|
|
correctly handles the top-level option being set to <code>None</code> (as it will be if no sub-options are enabled).</p>
|
||
|
|
<p>The <a href="usage/configuration/config_documentation.html">configuration manual</a> acts as a
|
||
|
|
reference to Synapse's configuration options for server administrators.
|
||
|
|
Remember that many readers will be unfamiliar with YAML and server
|
||
|
|
administration in general, so it is important that when you add
|
||
|
|
a configuration option the documentation be as easy to understand as possible, which
|
||
|
|
includes following a consistent format.</p>
|
||
|
|
<p>Some guidelines follow:</p>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<p>Each option should be listed in the config manual with the following format:</p>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<p>The name of the option, prefixed by <code>###</code>. </p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p>A comment which describes the default behaviour (i.e. what
|
||
|
|
happens if the setting is omitted), as well as what the effect
|
||
|
|
will be if the setting is changed.</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p>An example setting, using backticks to define the code block</p>
|
||
|
|
<p>For boolean (on/off) options, convention is that this example
|
||
|
|
should be the <em>opposite</em> to the default. For other options, the example should give
|
||
|
|
some non-default value which is likely to be useful to the reader.</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p>There should be a horizontal rule between each option, which can be achieved by adding <code>---</code> before and
|
||
|
|
after the option.</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><code>true</code> and <code>false</code> are spelt thus (as opposed to <code>True</code>, etc.)</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p>Example:</p>
|
||
|
|
<hr />
|
||
|
|
<h3 id="modules"><a class="header" href="#modules"><code>modules</code></a></h3>
|
||
|
|
<p>Use the <code>module</code> sub-option to add a module under <code>modules</code> to extend functionality.
|
||
|
|
The <code>module</code> setting then has a sub-option, <code>config</code>, which can be used to define some configuration
|
||
|
|
for the <code>module</code>.</p>
|
||
|
|
<p>Defaults to none.</p>
|
||
|
|
<p>Example configuration:</p>
|
||
|
|
<pre><code class="language-yaml">modules:
|
||
|
|
- module: my_super_module.MySuperClass
|
||
|
|
config:
|
||
|
|
do_thing: true
|
||
|
|
- module: my_other_super_module.SomeClass
|
||
|
|
config: {}
|
||
|
|
</code></pre>
|
||
|
|
<hr />
|
||
|
|
<p>Note that the sample configuration is generated from the synapse code
|
||
|
|
and is maintained by a script, <code>scripts-dev/generate_sample_config.sh</code>.
|
||
|
|
Making sure that the output from this script matches the desired format
|
||
|
|
is left as an exercise for the reader!</p>
|
||
|
|
|
||
|
|
</main>
|
||
|
|
|
||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
<a rel="prev" href="development/contributing_guide.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
<a rel="next" href="development/reviews.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
<div style="clear: both"></div>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
|
|
<a rel="prev" href="development/contributing_guide.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
<a rel="next" href="development/reviews.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
window.playground_copyable = true;
|
||
|
|
</script>
|
||
|
|
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="book.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
|
||
|
|
<!-- Custom JS scripts -->
|
||
|
|
<script type="text/javascript" src="docs/website_files/table-of-contents.js"></script>
|
||
|
|
<script type="text/javascript" src="docs/website_files/version-picker.js"></script>
|
||
|
|
<script type="text/javascript" src="docs/website_files/version.js"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|