आयात शैली गाइड

अद्भुत PEP8, जिसे आप शायद परिचित हैं यदि आप पायथन में विकसित कर रहे हैं, तो कोडिंग प्रक्रिया के दौरान उठने वाले सभी सवालों का जवाब नहीं देता है। नतीजतन, प्रत्येक विकास टीम PEP8 को एक आधार के रूप में लेती है और अपने स्वयं के मानकों को विकसित करती है, जिसे वह पालन करने की कोशिश करता है। कितनी टीमें - इतने सारे विकल्प। और यह एक आवश्यक कृत्रिम ढांचा है। एक टाइपोग्राफर या टाइप्टर के लिए एक ग्रिड की तरह, यह कोड को स्पष्ट, सुसंगत और सुसंगत दिखने में मदद करता है। सामान्य तौर पर, कोड स्वरूपण आपके व्यक्तित्व को दिखाने का स्थान नहीं है।

मुख्य प्रश्न पूछने से पहले, प्रिय सहयोगियों, मैं "स्वतंत्रता" के कुछ उदाहरण दिखाना चाहूंगा जो हर कोई खुद के लिए लेता है (या नम्रता से किसी और के निर्णय लेता है)।

""" Very long multiline description about function or class method """ 

मुझे व्यक्तिगत रूप से अधिक पसंद है

 """Very long multiline description about function or class method """ 

आयात ब्लॉक और पहले फ़ंक्शन या वर्ग के बीच की दूरी 2 खाली लाइनें है।

 from unittest import TestCase class BaseURLGeneratorTestCase(TestCase): pass 

विभिन्न कार्यों या कक्षाओं के बीच की दूरी भी 2 खाली लाइनें हैं। वर्ग विधियों के बीच की दूरी 1 खाली रेखा है। क्लास हेडर और पहली विधि के बीच की दूरी 1 खाली लाइन है।

 class TestSomething(TestCase): def test_some_stuff(self): pass def test_another_stuff(self): pass 

एक सूची / टपल / शब्दकोश, आदि के तत्वों की गणना - प्रत्येक नई पंक्ति से, अगर सब कुछ एक में फिट नहीं होता है:

 records = [first_object, second_object] records = [ first_object, second_object, third_object, fourth_object, ] 

वही लंबी तार्किक स्थिति के लिए जाता है:

 if ( user.is_client() and user.has_manager() and not user.is_banned() and user.has_company() ): do_something() 

यदि विधियों की श्रृंखला को कई लाइनों में तोड़ने की आवश्यकता है, तो अभिव्यक्ति को कोष्ठक में तैयार किया गया है। कोई बैकस्लैश (फू फ्यु) नहीं।

 templates = ( EmailTemplate.query .filter(EmailTemplate.type_id == type.id) .order_by(EmailTemplate.title) .all() ) 

एक तत्व का एक tuple x = (y,) या x = y, रूप में लिखा जाता है x = y, लेकिन यह भयानक लगता है, इसलिए मैं इस मामले में सूची x = [y] या सेट x = {y} साथ प्राप्त करना पसंद करता हूं, अन्य विकल्प हैं।

कोई नहीं के लिए जाँच करें:

 x = None if x: do_something() #  if x is not None: do_something() # -  

वैसे, टिप्पणियों को दो स्थानों से खारिज किया जाता है, एक नहीं।

अन्य बातों के अलावा, मैं स्ट्रिंग विधि से प्यार करता हूं ।format ()। '{0}'.format(x) '%s' % x तुलना में मेरी पसंद से अधिक है। लेकिन जब दो से अधिक सम्मिलन बिंदु होते हैं, तो आपको नामित तर्क का उपयोग करना चाहिए:

 '{name} {surname}, {address}'.format( name=name, surname=surname, address=address, ) 

अंतर्निहित स्ट्रिंग जुड़ाव अजीब लगता है, लेकिन इसके अलावा नेत्रहीन की तुलना में नेत्रहीन अच्छे हैं:

 message = _( u"    +, " u"     ?" ) 

डिक्शनरी को {'key': value, 'another_key': another_value} रूप में लिखा गया है, न कि dict(key=value, another_key=another_value) । यह नेत्रहीन क्लीनर है, सभी सामान्य संपादकों द्वारा एक शब्दकोष के रूप में हाइलाइट किया गया है, और नामांकित तर्कों के रूप में पारित नहीं किया गया है, इसके अलावा, ऐसी वस्तु का निर्माण तानाशाही के माध्यम से तेजी से काम करता है ()।

इस तरह के "सनक" के एक दर्जन से अधिक हैं और मुझे यकीन है कि वहाँ लोग उन्हें चुनौती देने और कोषेर कोड डिजाइन के अपने दृष्टिकोण की पेशकश करने के लिए तैयार होंगे। लेकिन अगर, दिए गए उदाहरणों के अनुसार, मेरे लिए सब कुछ कम या ज्यादा स्पष्ट है, तो बड़े (वास्तव में बड़े) आयात ब्लॉकों के डिजाइन के लिए, सब कुछ स्पष्ट नहीं है।

मैं एक बार एक काम के मसौदे में मॉड्यूल में से एक में आयात का एक फुटक्लॉथ में मिला था।

 ... from lib.util import https_wrapper, logout_user from lib.util import ajax, sudo_su, sudo_exit, transactional from lib.util import has_auth, get_demo from lib.util import get_user_registration_source_id from lib.util import ajax_validate, generate_timed_hash, get_auth_user from lib.util import render_template, check_timed_hash from lib.util import create_validate_response, update_user_in_session from lib.util import prepare_watermark_text ... 

मैंने खुद से सोचा: "व्हाट द हेल? .." और इसे फिर से लिखना मुझे पसंद है।

 from lib.util import ( https_wrapper, logout_user, ajax, sudo_su, sudo_exit, transactional, has_auth, get_demo, ) 

ठीक है, आप सिद्धांत को समझते हैं ...

जिसके लिए उन्होंने रिव्यू के दौरान हैक किया। जैसे कि पिछले संस्करण में भी जीवन का अधिकार है, यह फ्रीज के दौरान सुविधाजनक है और इसे पढ़ने के लिए अधिक सुविधाजनक लगता है। मैंने अपने विकल्प पर बहस करने का वादा किया और उसी समय इस पद के लिए एक लिंक दिया, और पता लगाया कि हैबरोवस्क लोग इस बारे में क्या सोचते हैं।

So. "नई पंक्ति की प्रत्येक वस्तु" का विचार बहुत महत्वपूर्ण है। सबसे पहले, यह सुंदर है :) दूसरे, फ्रीज के दौरान यह अपने फायदे देता है, कोई भ्रम नहीं है। यह एक उपयोगी संपत्ति है, हमें इसे बचाने की जरूरत है।

दूसरे संस्करण में, मॉड्यूल (या पैकेज) जिसमें से हम आयात करते हैं जैसे कि पाठ के बाद के पैराग्राफ (आयातित ऑब्जेक्ट) का शीर्षक। हर बार शीर्षक को दोहराने की कोई आवश्यकता नहीं है, हम पहले ही एक बार देख चुके हैं कि हम कहाँ से आयात करते हैं और हमारे पास हमारे द्वारा आयात की जाने वाली लाइन-बाय-लाइन सूची है। यदि किसी को इस स्रोत से आयात की सूची को पूरक करने की आवश्यकता है, तो वह बस सूची के अंत में जाता है, Enter दबाता है और पड़ोसी के बारे में एक विचार के साथ अपना (+ अल्पविराम) जोड़ता है। यह क्लीनर दिखता है, लाइनें छोटी होती हैं, वे तेजी से पढ़ी जाती हैं, आपको हर बार स्रोत को संलग्न / कॉपी करने की आवश्यकता नहीं होती है, जो कि, वैसे, इसका नाम बदला जा सकता है। प्रत्येक पंक्ति के लिए from bla_bla_bla import भाग को अनदेखा करने की कोई आवश्यकता नहीं है। आंखों के माध्यम से 4 रिक्त स्थान फिसलना बहुत आसान है।

सामान्य तौर पर, आयात के साथ ब्लॉक को डिजाइन करने के लिए बहुत सारे विकल्प हैं। लगभग एक दर्जन, कोई कम नहीं। उद्घाटन, समापन / समापन कोष्ठक को स्थानांतरित करने या न करने के लिए क्या मानदंड, क्या मापदंड के अनुसार, क्या छांटना है, के अनुसार बिल्कुल ठीक है ... लेकिन आपको कुछ सामान्य हर में आने की जरूरत है, पूरी विकास टीम को स्वीकृत समझौते का पालन करना होगा। अन्यथा अराजकता। मैं उन लोगों को जानता हूं जो इससे बिल्कुल भी परेशान नहीं हैं, क्योंकि PyCharm में एक शानदार ऑटो आयात है और देखने वाली बात है कि इस ब्लॉक में क्या होता है, इससे कोई फर्क नहीं पड़ता। लेकिन हमारे पास एक बड़ी टीम है, पाइक्रोम मुझे केवल रास्ते में उपयोग कर रहे हैं (अधिकांश उदात्त पर हैं, बाकी विम, इमैक्स, एक्लिप्स पर हैं), हमें यह सुनिश्चित करने की आवश्यकता है कि हर कोई आरामदायक और समझने योग्य हो। खैर, मेरे दृष्टिकोण से, आयात भी एक ऐसा कोड है जो अच्छा दिखने के योग्य है। सब के बाद, बनाए रखने की क्षमता। आपको क्या लगता है?

तो सर्वेक्षण।