Re: [openstack-dev] [Tricircle] Naming convention
Hi Chaoyi, > In the experience of development, using full name as far as possible to > reduce the PEP8 naming convention prompt ion. But if the naming will make us > hard to write one clause less than 80 characters(ensure one clause in one > line), then sometimes the abbreviation has to be done to balance the code > readability. That is fine. If we decide that how many characters in one word are not acceptable and need to be shortened beforehand, we can make more better rule for other members who will be in this project in the future. But once we get more people and make more lines in source(current: only 16483 lines), it's going to be difficult. Any thought would be appreciated. Cheers, Shinobu - Original Message - From: "joehuang" <joehu...@huawei.com> To: ski...@redhat.com, "OpenStack Development Mailing List (not for usage questions)" <openstack-dev@lists.openstack.org> Sent: Tuesday, April 5, 2016 11:09:38 AM Subject: RE: [openstack-dev] [Tricircle] Naming convention Hi, Shinobu, Fully agree with you that this is a dilemma situation: If we use full word, for example "availaibility_zone_aggregate", then the length of one line easily exceed 80 characters, especially if there are several indents, if we don't use short name, it's very difficult to make sure one clause in one line as far as possible. Even after we use shorter name, sometimes, this issue is still there :( In the experience of development, using full name as far as possible to reduce the PEP8 naming convention prompt ion. But if the naming will make us hard to write one clause less than 80 characters(ensure one clause in one line), then sometimes the abbreviation has to be done to balance the code readability. How do you think about this? Best Regards Chaoyi Huang ( Joe Huang ) -Original Message- From: Shinobu Kinjo [mailto:shinobu...@gmail.com] Sent: Tuesday, April 05, 2016 9:46 AM To: OpenStack Development Mailing List (not for usage questions) Subject: Re: [openstack-dev] [Tricircle] Naming convention Hi Chaoyi, Thank you for your reply. How about this: # tricircle/api/pod.py 94 aggregate = az_ag.create_ag_az(context, 95 ag_name=ag_name, 96az_name=az_name) ... 161ag = az_ag.get_ag_by_name(context, ag_name) Since there is zero impact on the system, you could ignore though. Cheers, Shinobu On Tue, Apr 5, 2016 at 10:08 AM, joehuang <joehu...@huawei.com> wrote: > Hi, Shinobu, > > Thanks for your suggestion. When using PyCharm as the IDE, one issue is that > if we use abbreviation for the word to name the function or variables, there > is some PEP8 promotion that you'd better to name it in a whole word, but not > abbreviation. > > Best Regards > Chaoyi Huang ( Joe Huang ) > > > -Original Message- > From: Shinobu Kinjo [mailto:shinobu...@gmail.com] > Sent: Saturday, April 02, 2016 7:40 AM > To: joehuang; OpenStack Development Mailing List (not for usage > questions) > Subject: Re: [openstack-dev] [Tricircle] Naming convention > > One of examples is: > > """ > tricircle/db/api.py > """ > authorize_quota_class_context(context, class_name): > > # This could become: > > auth_quota_class_ctx(ctx, class_name): > > # If we put some comment for this, this also could become: > > """ > Function: Ensure a request has right permission to given the project. > @ctx: user context > @class: class name > """ > auth_quota_ctx(ctx, class): > > Point here is, honestly not only name but also appropriate length of comment. > What do you think? > > Cheers, > Shinobu > > > On Sat, Apr 2, 2016 at 8:20 AM, joehuang <joehu...@huawei.com> wrote: >> yes, good idea, could you point out or report a bug which are not >> good naming. >> >> thanks. >> >> Sent from HUAWEI AnyOffice >> 发件人：shinobu.kj >> 收件人：openstack-dev, >> 时间：2016-04-02 06:21:50 >> 主题:[openstack-dev] [Tricircle] Naming convention >> >> Hi Team, >> >> Probably it's worth thinking of naming convention for classes, >> methods or whatever we define in source codes. >> >> Some names are lengthy and there might be no consistency. At the >> moment it's fine. But once this project gets growing, situation would >> become chaotic and could cause bugs. >> >> What do you think? >> >> Cheers, >> Shinobu >> >> -- >> Email: >> shin...@linux.com >> GitHub: >> shinobu-x >> Blog: >> Life with Distributed Computational
Re: [openstack-dev] [Tricircle] Naming convention
Hi, Shinobu, Fully agree with you that this is a dilemma situation: If we use full word, for example "availaibility_zone_aggregate", then the length of one line easily exceed 80 characters, especially if there are several indents, if we don't use short name, it's very difficult to make sure one clause in one line as far as possible. Even after we use shorter name, sometimes, this issue is still there :( In the experience of development, using full name as far as possible to reduce the PEP8 naming convention prompt ion. But if the naming will make us hard to write one clause less than 80 characters(ensure one clause in one line), then sometimes the abbreviation has to be done to balance the code readability. How do you think about this? Best Regards Chaoyi Huang ( Joe Huang ) -Original Message- From: Shinobu Kinjo [mailto:shinobu...@gmail.com] Sent: Tuesday, April 05, 2016 9:46 AM To: OpenStack Development Mailing List (not for usage questions) Subject: Re: [openstack-dev] [Tricircle] Naming convention Hi Chaoyi, Thank you for your reply. How about this: # tricircle/api/pod.py 94 aggregate = az_ag.create_ag_az(context, 95 ag_name=ag_name, 96az_name=az_name) ... 161ag = az_ag.get_ag_by_name(context, ag_name) Since there is zero impact on the system, you could ignore though. Cheers, Shinobu On Tue, Apr 5, 2016 at 10:08 AM, joehuang <joehu...@huawei.com> wrote: > Hi, Shinobu, > > Thanks for your suggestion. When using PyCharm as the IDE, one issue is that > if we use abbreviation for the word to name the function or variables, there > is some PEP8 promotion that you'd better to name it in a whole word, but not > abbreviation. > > Best Regards > Chaoyi Huang ( Joe Huang ) > > > -Original Message- > From: Shinobu Kinjo [mailto:shinobu...@gmail.com] > Sent: Saturday, April 02, 2016 7:40 AM > To: joehuang; OpenStack Development Mailing List (not for usage > questions) > Subject: Re: [openstack-dev] [Tricircle] Naming convention > > One of examples is: > > """ > tricircle/db/api.py > """ > authorize_quota_class_context(context, class_name): > > # This could become: > > auth_quota_class_ctx(ctx, class_name): > > # If we put some comment for this, this also could become: > > """ > Function: Ensure a request has right permission to given the project. > @ctx: user context > @class: class name > """ > auth_quota_ctx(ctx, class): > > Point here is, honestly not only name but also appropriate length of comment. > What do you think? > > Cheers, > Shinobu > > > On Sat, Apr 2, 2016 at 8:20 AM, joehuang <joehu...@huawei.com> wrote: >> yes, good idea, could you point out or report a bug which are not >> good naming. >> >> thanks. >> >> Sent from HUAWEI AnyOffice >> 发件人：shinobu.kj >> 收件人：openstack-dev, >> 时间：2016-04-02 06:21:50 >> 主题:[openstack-dev] [Tricircle] Naming convention >> >> Hi Team, >> >> Probably it's worth thinking of naming convention for classes, >> methods or whatever we define in source codes. >> >> Some names are lengthy and there might be no consistency. At the >> moment it's fine. But once this project gets growing, situation would >> become chaotic and could cause bugs. >> >> What do you think? >> >> Cheers, >> Shinobu >> >> -- >> Email: >> shin...@linux.com >> GitHub: >> shinobu-x >> Blog: >> Life with Distributed Computational System based on OpenSource >> >> _ >> _ OpenStack Development Mailing List (not for usage questions) >> Unsubscribe: >> openstack-dev-requ...@lists.openstack.org?subject:unsubscribe >> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev > > > > -- > Email: > shin...@linux.com > GitHub: > shinobu-x > Blog: > Life with Distributed Computational System based on OpenSource > __ > OpenStack Development Mailing List (not for usage questions) > Unsubscribe: > openstack-dev-requ...@lists.openstack.org?subject:unsubscribe > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev -- Email: shin...@linux.com GitHub: shinobu-x Blog: Life with Distributed Computational System based on OpenSource __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [Tricircle] Naming convention
Hi Chaoyi, Thank you for your reply. How about this: # tricircle/api/pod.py 94 aggregate = az_ag.create_ag_az(context, 95 ag_name=ag_name, 96az_name=az_name) ... 161ag = az_ag.get_ag_by_name(context, ag_name) Since there is zero impact on the system, you could ignore though. Cheers, Shinobu On Tue, Apr 5, 2016 at 10:08 AM, joehuang <joehu...@huawei.com> wrote: > Hi, Shinobu, > > Thanks for your suggestion. When using PyCharm as the IDE, one issue is that > if we use abbreviation for the word to name the function or variables, there > is some PEP8 promotion that you'd better to name it in a whole word, but not > abbreviation. > > Best Regards > Chaoyi Huang ( Joe Huang ) > > > -Original Message- > From: Shinobu Kinjo [mailto:shinobu...@gmail.com] > Sent: Saturday, April 02, 2016 7:40 AM > To: joehuang; OpenStack Development Mailing List (not for usage questions) > Subject: Re: [openstack-dev] [Tricircle] Naming convention > > One of examples is: > > """ > tricircle/db/api.py > """ > authorize_quota_class_context(context, class_name): > > # This could become: > > auth_quota_class_ctx(ctx, class_name): > > # If we put some comment for this, this also could become: > > """ > Function: Ensure a request has right permission to given the project. > @ctx: user context > @class: class name > """ > auth_quota_ctx(ctx, class): > > Point here is, honestly not only name but also appropriate length of comment. > What do you think? > > Cheers, > Shinobu > > > On Sat, Apr 2, 2016 at 8:20 AM, joehuang <joehu...@huawei.com> wrote: >> yes, good idea, could you point out or report a bug which are not >> good naming. >> >> thanks. >> >> Sent from HUAWEI AnyOffice >> 发件人：shinobu.kj >> 收件人：openstack-dev, >> 时间：2016-04-02 06:21:50 >> 主题:[openstack-dev] [Tricircle] Naming convention >> >> Hi Team, >> >> Probably it's worth thinking of naming convention for classes, methods >> or whatever we define in source codes. >> >> Some names are lengthy and there might be no consistency. At the >> moment it's fine. But once this project gets growing, situation would >> become chaotic and could cause bugs. >> >> What do you think? >> >> Cheers, >> Shinobu >> >> -- >> Email: >> shin...@linux.com >> GitHub: >> shinobu-x >> Blog: >> Life with Distributed Computational System based on OpenSource >> >> __ >> OpenStack Development Mailing List (not for usage questions) >> Unsubscribe: >> openstack-dev-requ...@lists.openstack.org?subject:unsubscribe >> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev > > > > -- > Email: > shin...@linux.com > GitHub: > shinobu-x > Blog: > Life with Distributed Computational System based on OpenSource > __ > OpenStack Development Mailing List (not for usage questions) > Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev -- Email: shin...@linux.com GitHub: shinobu-x Blog: Life with Distributed Computational System based on OpenSource __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [Tricircle] Naming convention
Hi, Shinobu, Thanks for your suggestion. When using PyCharm as the IDE, one issue is that if we use abbreviation for the word to name the function or variables, there is some PEP8 promotion that you'd better to name it in a whole word, but not abbreviation. Best Regards Chaoyi Huang ( Joe Huang ) -Original Message- From: Shinobu Kinjo [mailto:shinobu...@gmail.com] Sent: Saturday, April 02, 2016 7:40 AM To: joehuang; OpenStack Development Mailing List (not for usage questions) Subject: Re: [openstack-dev] [Tricircle] Naming convention One of examples is: """ tricircle/db/api.py """ authorize_quota_class_context(context, class_name): # This could become: auth_quota_class_ctx(ctx, class_name): # If we put some comment for this, this also could become: """ Function: Ensure a request has right permission to given the project. @ctx: user context @class: class name """ auth_quota_ctx(ctx, class): Point here is, honestly not only name but also appropriate length of comment. What do you think? Cheers, Shinobu On Sat, Apr 2, 2016 at 8:20 AM, joehuang <joehu...@huawei.com> wrote: > yes, good idea, could you point out or report a bug which are not > good naming. > > thanks. > > Sent from HUAWEI AnyOffice > 发件人：shinobu.kj > 收件人：openstack-dev, > 时间：2016-04-02 06:21:50 > 主题:[openstack-dev] [Tricircle] Naming convention > > Hi Team, > > Probably it's worth thinking of naming convention for classes, methods > or whatever we define in source codes. > > Some names are lengthy and there might be no consistency. At the > moment it's fine. But once this project gets growing, situation would > become chaotic and could cause bugs. > > What do you think? > > Cheers, > Shinobu > > -- > Email: > shin...@linux.com > GitHub: > shinobu-x > Blog: > Life with Distributed Computational System based on OpenSource > > __ > OpenStack Development Mailing List (not for usage questions) > Unsubscribe: > openstack-dev-requ...@lists.openstack.org?subject:unsubscribe > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev -- Email: shin...@linux.com GitHub: shinobu-x Blog: Life with Distributed Computational System based on OpenSource __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [Tricircle] Naming convention
One of examples is: """ tricircle/db/api.py """ authorize_quota_class_context(context, class_name): # This could become: auth_quota_class_ctx(ctx, class_name): # If we put some comment for this, this also could become: """ Function: Ensure a request has right permission to given the project. @ctx: user context @class: class name """ auth_quota_ctx(ctx, class): Point here is, honestly not only name but also appropriate length of comment. What do you think? Cheers, Shinobu On Sat, Apr 2, 2016 at 8:20 AM, joehuang <joehu...@huawei.com> wrote: > yes, good idea, could you point out or > report a bug which are not good naming. > > thanks. > > Sent from HUAWEI AnyOffice > 发件人：shinobu.kj > 收件人：openstack-dev, > 时间：2016-04-02 06:21:50 > 主题:[openstack-dev] [Tricircle] Naming convention > > Hi Team, > > Probably it's worth thinking of naming convention for classes, methods > or whatever we define in source codes. > > Some names are lengthy and there might be no consistency. At the > moment it's fine. But once this project gets growing, situation would > become chaotic and could cause bugs. > > What do you think? > > Cheers, > Shinobu > > -- > Email: > shin...@linux.com > GitHub: > shinobu-x > Blog: > Life with Distributed Computational System based on OpenSource > > __ > OpenStack Development Mailing List (not for usage questions) > Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev -- Email: shin...@linux.com GitHub: shinobu-x Blog: Life with Distributed Computational System based on OpenSource __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
[openstack-dev] [Tricircle] Naming convention
Hi Team, Probably it's worth thinking of naming convention for classes, methods or whatever we define in source codes. Some names are lengthy and there might be no consistency. At the moment it's fine. But once this project gets growing, situation would become chaotic and could cause bugs. What do you think? Cheers, Shinobu -- Email: shin...@linux.com GitHub: shinobu-x Blog: Life with Distributed Computational System based on OpenSource __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
