Function naming conventions about 30-seconds-of-python

[lsrdg]

It sounds like a really python centric/minded/focused project, so no reason to use other language's styles.

We can set up a linter when we have decided the code-style to be used. Also do you know any code prettifiers for python I couldn't find anything else than yapf

If the linter detects any error the pass will fail and won't be merged until a new commit (added to the PR) fix that. I fail to see why to automatically prettify the code... :/

Tools to take a look at:

• flake8
• pylint
• autopep8

[rohitanwar]

@lsrdg Wait that is an error in the contributing.md. Just remove the PEP8 link. PR it if you want to 👍

[lsrdg]

If it is just that I can do it right now, but are you sure? I thought the PR would be the other way around: rename the functions, so that all functions follow the same style.

[rohitanwar]

No actually first I thought of following the PEP8 guidelines but then I met yapf. So I updated it but forgot to remove the PEP8 part. If you are busy I shall do it.

[lsrdg]

I think you should it, even better if you clarify why the project is taking this specific direction. Since it is a python project, I would rather follow pep8, flake8, pylint etc and not what google has to say about that, but totally respect your decision. (=

[rohitanwar]

Yeah I think you right about following the right style conventions. I think I was stupid to use javascript naming conventions in python. I will reopen to issue to discuss the styles to be used. :)

…

On 9 Jan 2018 6:25 p.m., "lsrdg" ***@***.***> wrote: I think you should it, even better if you clarify why the project is taking this specific direction. Since it is a python project, I would rather follow pep8, flake8, pylint etc and not what google has to say about that, but totally respect your decision. (= — You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHub <#1 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AeUc5iCbXS33JVGZvmFh08aqanU7pQCEks5tI2HegaJpZM4RXjXY> .

[lsrdg]

In python, I guess "we are all adults"... but maybe it helps if you define the target(s) user(s) group(s)?

If most users are coming here after knowing the javascript version, the js naming style would be one less thing to worry about and people would focus on the code itself.

Experienced programmers just getting started with python will use their own filters to decide what to use or not.

However, people just starting their path (python as a first language) might need a reinforcement of good code style. Intermediates who are constancy reading the docs won't have a problem with that, but it might be a mental relief to know what type an object is just by staring at it.

You can also just set up a linter of your choice on travis and tell people that their PR will be merged when all tests are passing.

What are your thoughts on the topic?

[rohitanwar]

The target users are both beginners who have just started learning python to experts (adults) who use it daily. We will be helping the beginners as each of our code is accompanied with a short and clear description about the inbuilt python function and modules we use. We will help the everyday users by providing copy-paste snippets that might need to use on a regular basis. (Although it is not the main focus but we might provide a library/module with all the snippets).

No we are not going to get any traffic from the Javascript version as this project is not mentioned anywhere in their project.

Yeah I think you are right about reinforcing good code style and I think I have included a checkbox if the code style of this project is used by there code in the PR-template. I believe there are many code-styles which have little differences. We should use the most used one so that most of the advanced users are comfortable with it.

Yeah I think you are right about mention somewhere that there PR will be merged when tests pass. I think we can even ensure that there examples are working as intended. We can set up a linter when we have decided the code-style to be used. Also do you know any code prettifiers for python I couldn't find anything else than yapf

[rohitanwar]

I went through all them and came to the conclusion that they check your code for errors .
I also searched for them on Google and read that pylint has many unnecessary errors and warnings.

But I really liked autopep8 and I think it prettifies your code too.

So I think we have made a decision but I wanted your opinions on it.

Also would like to submit a PR to integrate autopep8. I might be able to do you it after reading the documentation but as you are more experienced you will do it better.

[Rob-Rychs]

Hey guys I just found this looks pretty good for pep8 too...

[lsrdg]

I've used flake8 and autopep8 in a project, but when I tried pylint (locally) it did point to so many stuff that I learned a lot. I'm using flake8 on travis and pylint locally for my own sake... whichever tool you choose will give a decent code style, but again I fail to see why the code should be automatically prettified. (:

but as you are more experienced you will do it better.

Nope. Just a learner as well. It is nice to open the space for discussion, but as the maintainer it is up to you @kriadmin to take a decision. We always assign an issue to ourselves or open an issue to discuss whatever is relevant. (:

@Rob-Rychs , well pointed. That's what I liked about flake8:

Flake8 is a wrapper around these tools:

- PyFlakes
- pycodestyle
- Ned Batchelder's McCabe script

[rohitanwar]

@lsrdg I want to auto-prettify code because some people really like to write babdly formatted code(I am an example).

@Rob-Rychs I will check that out in the evening today(I am +5:30) and will be busy today. And after checking it out I will decide on one(hopefully) and then integrate it for travis-ci

[lsrdg]

@kriadmin aha, no problems. Probably I'm just on the side of the people who really enjoy using a text editor :P

In this case, you can create another branch to test the linter+prettifier and we can keep the discussion on the PR, what do you think?

[rohitanwar]

Yes I was thinking of making a branch to test it but I am really busy because I have exams coming. Still I will try my best to make a PR soon.

[lock]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for any follow-up tasks.