[Python-ideas] PEP: Shorthand Symbol for "self"

Russ Paielli russ.paielli at gmail.com
Wed Aug 27 02:02:39 CEST 2008


My editor, Xemacs, also highlights the word "self." I personally find that a
bit annoying, and perhaps that is part of the reason I don't appreciate the
word. When I write an algorithm, I don't want to see some artifact
highlighted, as if it is somehow the most important part of the algorithm. I
like seeing keywords highlighted, but I don't want to see "self" highlighted
because it is only a convention. Maybe I'm alone on that.

As I wrote earlier, I copied one of my larger Python files and replaced each
occurrence of "self" with "S". That was approximately 350 occurrences. I
also replaced each occurrence of "cls" with "C", which was another 50 or so
occurrences. The file size was reduced by 2.8%, many wrapped lines no longer
need to wrap, and I like the way it looks.

I understand that people like to have "one true way," but I think Python
programmers are adaptable enough to handle this one. When you read code, you
certainly need to read the argument names anyway, so the fact that "S" is
being used instead of "self" should be obvious. The only minor disadvantage
I can think of is that searching on a single character can be problematic,
but if you are using an IDE, that should not be an issue (and I can't
remember ever searching on "self" anyway).

One of these days, when I get a chance, I may write an informational PEP
recommending the use of "S" as an acceptable replacement for "self", and "C"
as an accptable replacement for "cls". I hope that doesn't blow any fuses.

Have a nice day.

--Russ

On Mon, Aug 25, 2008 at 11:58 PM, Torsten Bronger <
bronger at physik.rwth-aachen.de> wrote:

> Hallöchen!
>
> Russ Paielli writes:
>
> > Just for fun, I made a copy of one of my Python files with
> > hundreds of occurrences of "self", and I replaced them all with
> > "S". This streamlines things significantly, and I think it looks
> > good, but I suppose most Python aficionados would be aghast. I'm
> > thinking about doing it permanently for all my files. I normally
> > avoid single-character names, but I think this case could be a
> > reasonable exception. What would you think if you saw this in
> > "production" code?
>
> The "self" convention goes so far that my editor highlights it --
> this may be true for other editors/HTML highlighters, too.  I'd even
> frown upon any programmer who breaks this convention for code that
> has the slightest chance to become public.
>
> Besides, I don't consider "self"s cluttering up the code.  YMMV, but
> I don't measure code legibility by the terseness of certain
> identifies at all.
>
> Tschö,
> Torsten.
>
> --
> Torsten Bronger, aquisgrana, europa vetus
>                   Jabber ID: torsten.bronger at jabber.rwth-aachen.de
>
> _______________________________________________
> Python-ideas mailing list
> Python-ideas at python.org
> http://mail.python.org/mailman/listinfo/python-ideas
>



-- 
http://RussP.us
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-ideas/attachments/20080826/65843dc0/attachment.html>


More information about the Python-ideas mailing list