https://waylonwalker.com/tags/dicuss/atom.xml 2020-04-08T11:03:00Z All posts with the tag "dicuss" Waylon Walker markata-go https://waylonwalker.com/variable-names-don-t-need-their-type/ 2020-04-08T11:03:00Z 2020-04-08T11:03:00Z

So often I see a variables inside of its name and it hurts me a little inside. Tell me I'm right or prove me wrong below.

<p>So often I see a variables <code>type()</code> inside of its name and it hurts me a little inside. Tell me I’m right or prove me wrong below.</p> <h2 id="examples">Examples <a href="#examples" class="heading-anchor">#</a></h2> <p>Pandas <code>DataFrames</code> are probably the worst offender that I see</p> <pre class="chroma"><code><span class="line"><span class="cl"><span class="c1"># bad</span> </span></span><span class="line"><span class="cl"><span class="n">sales_df</span> <span class="o">=</span> <span class="n">get_sales</span><span class="p">()</span> </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"><span class="c1"># good</span> </span></span><span class="line"><span class="cl"><span class="n">sales</span> <span class="o">=</span> <span class="n">get_sales</span><span class="p">()</span> </span></span></code></pre><p>Sometimes vanilla structures too!</p> <pre class="chroma"><code><span class="line"><span class="cl"><span class="c1"># bad</span> </span></span><span class="line"><span class="cl"><span class="n">items_list</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;sneakers&#39;</span><span class="p">,</span> <span class="s1">&#39;pencils&#39;</span><span class="p">,</span> <span class="s1">&#39;paper&#39;</span><span class="p">,</span> <span class="p">]</span> </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"><span class="c1"># good</span> </span></span><span class="line"><span class="cl"><span class="n">items</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;sneakers&#39;</span><span class="p">,</span> <span class="s1">&#39;pencils&#39;</span><span class="p">,</span> <span class="s1">&#39;paper&#39;</span><span class="p">,</span> <span class="p">]</span> </span></span></code></pre><h2 id="edge-cases">Edge Cases? <a href="#edge-cases" class="heading-anchor">#</a></h2> <p>It’s so common when you need to get inside a data structure in a special way that itsn’t provided by the library…. I am not exactly sure of a good way around it.</p> <pre class="chroma"><code><span class="line"><span class="cl"><span class="c1"># bad ??</span> </span></span><span class="line"><span class="cl"><span class="n">sales</span> <span class="o">=</span> <span class="n">get_sales</span><span class="p">()</span> </span></span><span class="line"><span class="cl"><span class="n">sales_dict</span> <span class="o">=</span> <span class="n">sales</span><span class="o">.</span><span class="n">to_dict</span><span class="p">()</span> </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"><span class="c1"># good</span> </span></span><span class="line"><span class="cl"><span class="err">🤷‍♀️</span> </span></span></code></pre><h2 id="containers-are-plural">Containers are plural <a href="#containers-are-plural" class="heading-anchor">#</a></h2> <p>Always name your containers plural, so that naming while iterating is simple.</p> <pre class="chroma"><code><span class="line"><span class="cl"><span class="n">prices</span> <span class="o">=</span> <span class="p">{}</span> </span></span><span class="line"><span class="cl"><span class="n">items</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;sneakers&#39;</span><span class="p">,</span> <span class="s1">&#39;pencils&#39;</span><span class="p">,</span> <span class="s1">&#39;paper&#39;</span><span class="p">,</span> <span class="p">]</span> </span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">items</span><span class="p">:</span> </span></span><span class="line"><span class="cl"> <span class="n">prices</span><span class="p">[</span><span class="n">item</span><span class="p">]</span> <span class="o">=</span> <span class="n">get_price</span><span class="p">(</span><span class="n">item</span><span class="p">)</span> </span></span></code></pre><p>Before I start fights 🥊 in code review, am I inline here or just being pedantic?</p> Waylon Walker hello@waylonwalker.com https://waylonwalker.com