-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathusing_camelcase_in_function_names.html
More file actions
229 lines (148 loc) · 10.1 KB
/
Copy pathusing_camelcase_in_function_names.html
File metadata and controls
229 lines (148 loc) · 10.1 KB
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
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Using CamelCase in function names — Python Anti-Patterns documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/ribbon.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/font-awesome-4.1.0/css/font-awesome.min.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/menu.css" type="text/css" />
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Python Anti-Patterns documentation" href="../index.html"/>
<link rel="up" title="Readability" href="index.html"/>
<link rel="next" title="Security" href="../security/index.html"/>
<link rel="prev" title="Using map() or filter() where list comprehension is possible" href="using_map_or_filter_where_list_comprehension_is_possible.html"/>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="../index.html"> Python Anti-Patterns</a>
<div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../correctness/index.html"><i class="fa fa-check"></i> Correctness</a></li>
<li class="toctree-l1"><a class="reference internal" href="../maintainability/index.html"><i class="fa fa-puzzle-piece"></i> Maintainability</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html"><i class="fa fa-eye"></i> Readability</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="asking_for_permission_instead_of_forgiveness_when_working_with_files.html">Asking for permission instead of forgiveness</a></li>
<li class="toctree-l2"><a class="reference internal" href="comparison_to_none.html">Comparing things to <cite>None</cite> the wrong way</a></li>
<li class="toctree-l2"><a class="reference internal" href="comparison_to_true.html">Comparing things to <cite>True</cite> the wrong way</a></li>
<li class="toctree-l2"><a class="reference internal" href="do_not_compare_types_use_isinstance.html">Using <cite>type()</cite> to compare types</a></li>
<li class="toctree-l2"><a class="reference internal" href="not_using_a_dict_comprehension.html">Not using dict comprehensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="not_using_dict_keys_when_formatting_strings.html">Not using dict keys when formatting strings</a></li>
<li class="toctree-l2"><a class="reference internal" href="not_using_items_to_iterate_over_a_dictionary.html">Not using <code class="docutils literal"><span class="pre">items()</span></code> to iterate over a dictionary</a></li>
<li class="toctree-l2"><a class="reference internal" href="not_using_named_tuples_when_returning_more_than_one_value.html">Not using named tuples when returning more than one value from a function</a></li>
<li class="toctree-l2"><a class="reference internal" href="not_using_unpacking_for_updating_multiple_values_at_once.html">Not using unpacking for updating multiple values at once</a></li>
<li class="toctree-l2"><a class="reference internal" href="not_using_zip_to_iterate_over_a_pair_of_lists.html">Not using <code class="docutils literal"><span class="pre">zip()</span></code> to iterate over a pair of lists</a></li>
<li class="toctree-l2"><a class="reference internal" href="putting_type_information_in_a_variable_name.html">Putting type information in a variable name</a></li>
<li class="toctree-l2"><a class="reference internal" href="test_for_object_identity_should_be_is_not.html">Test for object identity should be <code class="docutils literal"><span class="pre">is</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="using_an_unpythonic_loop.html">Using an unpythonic loop</a></li>
<li class="toctree-l2"><a class="reference internal" href="using_map_or_filter_where_list_comprehension_is_possible.html">Using <code class="docutils literal"><span class="pre">map()</span></code> or <code class="docutils literal"><span class="pre">filter()</span></code> where list comprehension is possible</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Using <cite>CamelCase</cite> in function names</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../security/index.html"><i class="fa fa-lock"></i> Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../performance/index.html"><i class="fa fa-dashboard"></i> Performance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../django/index.html"><i class="fa fa-book"></i> Django</a></li>
</ul>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Python Anti-Patterns</a>
</nav>
<div class="wy-nav-content" id="signup-box" >
<div class="rst-content">
<div class="navigation" role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Documentation</a> »</li>
<li><a href="index.html"><i class="fa fa-eye"></i> Readability</a> »</li>
<li>Using <cite>CamelCase</cite> in function names</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/readability/using_camelcase_in_function_names.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section" id="using-camelcase-in-function-names">
<h1>Using <cite>CamelCase</cite> in function names<a class="headerlink" href="#using-camelcase-in-function-names" title="Permalink to this headline">¶</a></h1>
<p>Per the PEP 8 Style Guide, function names should be lowercase, with words separated by underscores.</p>
<div class="section" id="anti-pattern">
<h2>Anti-pattern<a class="headerlink" href="#anti-pattern" title="Permalink to this headline">¶</a></h2>
<div class="code python highlight-default"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">someFunction</span><span class="p">():</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">"Is not the preferred PEP 8 pattern for function names"</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="best-practice">
<h2>Best practice<a class="headerlink" href="#best-practice" title="Permalink to this headline">¶</a></h2>
<div class="section" id="using-lowercase-with-underscores">
<h3>Using lowercase with underscores<a class="headerlink" href="#using-lowercase-with-underscores" title="Permalink to this headline">¶</a></h3>
<p>The code below uses the PEP 8 preferred pattern of function names.</p>
<div class="code python highlight-default"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">some_function</span><span class="p">():</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">"PEP 8 Style Guide prefers this pattern"</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="references">
<h2>References<a class="headerlink" href="#references" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference external" href="https://www.python.org/dev/peps/pep-0008/#function-names">PEP8 Style Guide - Function names</a></li>
</ul>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../security/index.html" class="btn btn-neutral float-right" title="Security"/>Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="using_map_or_filter_where_list_comprehension_is_possible.html" class="btn btn-neutral" title="Using map() or filter() where list comprehension is possible"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
</p>
</div>
<!--End mc_embed_signup-->
<a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a> - Last updated: Jan 11, 2018
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'',
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>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
<!-- Place this tag right after the last button or just before your close body tag. -->
<script async defer id="github-bjs" src="https://buttons.github.io/buttons.js"></script>
</body>
</html>

