👨🏾‍💼 🎅🏿 ♌️ परियोजना के लिए निर्देशिका संरचना (विशेष रूप से फ्लास्क पर) 👃🏾 💨 💡

लेख उस प्रश्न का उत्तर देगा जो कई प्रोग्रामर के लिए समय की हानि का कारण था: भविष्य या मौजूदा परियोजना के लिए किस निर्देशिका संरचना का उपयोग किया जाना चाहिए? न केवल परियोजना की वर्तमान अवधारणा के लिए कौन सी संरचना सबसे इष्टतम होगी, बल्कि भविष्य में परियोजना का विस्तार करने या इसे भागों में विभाजित करने के मामले में इतनी दर्दनाक नहीं होगी?

जड़

और इसलिए हमने प्रोजेक्ट शुरू किया। इसे myapp का सबसे आसान प्रोजेक्ट होने दें। हम विकास के लिए मुख्य फ़ोल्डर में इसके लिए एक निर्देशिका बनाते हैं (मेरे पास यह डेवेल है)।

mkdir myapp cd myapp

भविष्य में, सभी कार्य मुख्य परियोजना निर्देशिका के अंदर होंगे

Git

एक खाली भंडार का प्रारंभ करें

 git init

.gitignore

 #   *.pyc *.pyo **/__pycache__/ #      **/config/ #       **/data/ **/logs/ #        (  ) **/bin/

मुझे पढ़ा दो

अगला कदम आवश्यक README फ़ाइल बनाना है। इस फ़ाइल में हमारी भविष्य की परियोजना का मुख्य और मुख्य विवरण है। कुछ लोग README.txt नामक एक पाठ / सादा फ़ाइल बनाते हैं। बड़े पोर्टल्स पर, README.md नाम के साथ मार्कडाउन मानक के लिए रिपॉजिटरी स्वीकार किए जाते हैं। मुझे html पसंद है, क्योंकि मेरे लिए रंग चयन, लिंक, चित्र और अन्य मल्टीमीडिया बनाना, ब्राउज़र में खोलना, <pre> और <code> टैग में कोड के टुकड़े एम्बेड करना, सजावट के लिए तैयार फ्रेमवर्क का उपयोग करना और हॉगवर्ट्स के बाहर अन्य जादू का उपयोग करना अधिक सुविधाजनक है। तदनुसार, नाम README.html

 touch README.html

यदि परियोजना कई टीमों द्वारा संचालित की जाती है, तो मैं सुझाव देता हूं कि प्रत्येक टीम के पास स्वतंत्र रूप से विकसित मॉड्यूल, घटक, पुस्तकालय, आदि के अंदर अपनी स्वयं की README फाइल हो।

आवेदन

मैं मुख्य एप्लिकेशन डायरेक्टरी को प्रोजेक्ट डायरेक्टरी की तरह ही नाम देता हूं। इस लेख के मामले में, myapp

 mkdir myapp touch myapp/__init__.py

मॉड्यूल और घटक

एप्लिकेशन डायरेक्टरी के अंदर, __init__.py को डिफ़ॉल्ट रूप से बनाया जाता है, जिसमें एप्लिकेशन के लिए इनिशियलाइज़ेशन कोड होता है और एप्लिकेशन के सभी आवश्यक भागों को जोड़ता है। विशेष रूप से, ये एक अलग सेवा के तर्क के लिए एकल-शाखा URL या नामस्थान के ब्लूप्रिंट हैं, लेकिन अलग-अलग URL के साथ (एक सरल उदाहरण ब्लॉग लेख सेवा के लिए एक नाम स्थान बना रहा है, जहाँ प्रपत्र / पृष्ठ और / पृष्ठ / आईडी के स्पष्ट रूप से अलग-अलग पथ हैं)

 mkdir myapp/bp_component touch myapp/bp_component/__init__.py

या

 mkdir myapp/ns_component touch myapp/ns_component/__init__.py

DB मॉडल

डेटाबेस मॉडल में डेटाबेस इनिशियलाइज़ेशन कोड के साथ-साथ कनेक्शन भी होते हैं। और, ज़ाहिर है, तालिकाओं और संबंधों की संरचना। आवेदन के व्यावसायिक तर्क के आधार पर अलग-अलग फ़ाइलों में तालिकाओं का चयन करना भी वांछनीय है। एक अलग फ़ाइल में टेबल और लिंक की कई कक्षाओं का वर्णन सुविधाजनक है क्योंकि आप वांछित फ़ाइल को किसी अन्य प्रोजेक्ट में कॉपी करके आसानी से कोड का पुन: उपयोग कर सकते हैं या विभिन्न परियोजनाओं के लिए साझा लाइब्रेरी से फ़ाइल के लिए प्रतीकात्मक लिंक का उपयोग कर सकते हैं।

 mkdir myapp/models touch myapp/models/__init__.py touch myapp/models/page.py

टेम्पलेट इंजन के लिए टेम्प्लेट

कुछ एप्लिकेशन (मुख्य रूप से वेब एप्लिकेशन) को पत्ती पृष्ठों को उत्पन्न करने के लिए टेम्पलेट्स के उपयोग की विशेषता है। चूंकि मुख्य लक्ष्य निष्पादन योग्य कोड को डेटा प्रस्तुति से अलग करना है, इसलिए यह कदम टीम को प्रोग्रामर और डिजाइनरों के समानांतर काम की संभावना प्रदान करके बहुत समय, प्रयास और पैसा बचाने में मदद करेगा।

 mkdir myapp/templates mkdir myapp/templates/html mkdir myapp/templates/js mkdir myapp/templates/css

मैं ध्यान देता हूं कि इस मामले में, js और css उपनिर्देशिका स्थैतिक जावास्क्रिप्ट पुस्तकालयों या सीएसएस शैलियों को संग्रहीत करने के लिए नहीं हैं, लेकिन परस्पर कोड, पैरामीटर कोड या एम्बेड कोड के लिए हैं। उदाहरण के लिए, यदि बटन के साथ अतिरिक्त कार्यक्षमता के साथ एक कैलेंडर ड्राइंग घटक है, तो कैलेंडर घटक को js में रखना और HTML फ़ाइलों में घटक को सक्षम करने के लिए बहुत अधिक सुविधाजनक होगा, लेकिन आवश्यक मापदंडों के साथ। शायद यह किसी को किसी प्रकार की गंदगी की तरह प्रतीत होगा, लेकिन यह तैयार-किए गए स्थैतिक कैलेंडर लाइब्रेरी बनाने से बहुत बेहतर है, और आधे साल या एक साल के बाद यह समझने के लिए कि आपको घटक को कुछ और तीन गुणों और विधियों को जोड़ने की आवश्यकता है (उदाहरण के लिए, न केवल एक महीने के रूप में डेटापिक करें, बल्कि और इसे एक वर्ष के लिए कैलेंडर में बदलने की क्षमता जोड़ें), और किस तरह का जादू अंदर था, किसी को याद नहीं होगा। आवेषण अधिक पारदर्शिता देंगे।

स्थिति-विज्ञान

यहाँ, सभी मुख्य शैलियाँ जो कभी नहीं बदलती (या अत्यंत दुर्लभ रूप से बदलती हैं) शैलियाँ, चित्र, ध्वनियाँ, जेएस लाइब्रेरी और चौखटे हैं।

 mkdir myapp/static mkdir myapp/static/css mkdir myapp/static/js mkdir myapp/static/images

फंक्शन लाइब्रेरी

पुस्तकालयों को जोड़ने में आसानी मुख्य रूप से भाषा और रूपरेखा पर निर्भर करती है। पुस्तकालय नहीं हैं जो रिपॉजिटरी से जुड़े हैं और स्वतंत्र डेवलपर्स द्वारा समर्थित हैं। यहाँ आपके अपने सहायक कार्य हैं। उदाहरण के लिए, मार्ग को संसाधित करते समय मेरे पास कुछ सज्जाकार कार्य हैं, लेकिन मुख्य फ़ंक्शन को कॉल करने से पहले।

 mkdir myapp/lib touch myapp/lib/__init__.py

सेटिंग्स और कॉन्फ़िगरेशन

वैश्विक अनुप्रयोग सेटिंग्स को परिभाषित करने वाली सेटिंग्स को कैसे स्टोर करें? इस संबंध में कितने झगड़े हुए और गिनती नहीं हुई। विवरण के बिना, मैं यह कैसे करता हूं: मैं इसे एक अलग निर्देशिका में पायथन मॉड्यूल के रूप में संग्रहीत करता हूं। विभिन्न लॉन्च मोड के लिए फ़ाइलों के अंदर।

 mkdir config echo "CONFIG = 'config.devel'" > config/__init__.py touch config/devel.py touch config/prod.py

क्यों चिता? हां, क्योंकि XML, YAML, INI और अन्य बकवास की पार्सिंग, जब हाथ में फॉर्म के वेरिएबल बनाना काफी आसान है, किसी को भी पास नहीं किया गया है:

 import os DEBUG = True TITLE = 'SpecialistOff.NET' DIR_BASE = '/'.join(os.path.dirname(os.path.abspath(__file__)).split('/')[:-1]) DIR_DATA = DIR_BASE + '/data' DIR_FILES = DIR_DATA + '/files' MIMETYPES = { 'gif': 'image/gif', 'jpg': 'image/jpeg', 'jpeg': 'image/jpeg', 'png': 'image/png', 'txt': 'text/plain' } SERVERS = [ {'name': 'server1', 'IP': '8.8.8.8', 'port': '80'} ]

डेटा

फ़ाइलें, लॉग और ऑपरेशन के दौरान लोड किए गए अन्य डेटा को एक अलग डेटा निर्देशिका में संग्रहीत किया जाता है

 mkdir data mkdir data/files

परीक्षण

परीक्षण मॉड्यूल और जुड़नार

 mkdir tests mkdir tests/fixture touch tests/__init__.py touch test.py chmod +x test.py

प्रलेखन

सभी परियोजना प्रलेखन को अलग रखा जाना चाहिए। मैं इसके लिए डॉक्टर निर्देशिका का उपयोग करता हूं और इसे एक स्थिर वेब पेज के रूप में एक index.html प्रविष्टि बिंदु के साथ संग्रहीत करता हूं। यह सुविधाजनक है क्योंकि मैं किसी भी वेब सर्वर के माध्यम से एक अलग प्रलेखन निर्देशिका साझा कर सकता हूं। या डायरेक्ट्री से सीधे किसी भी वेब ब्राउजर के साथ ब्राउज़ करें (कंसोल जैसे लायनक्स, एलिंक्स सहित)।

 mkdir doc touch doc/index.html

तैनाती

यह सब कार्यों पर निर्भर करता है। और टिप्पणियों में (मेरी विनम्र राय में) विशेष रूप से आवश्यक नहीं है।

 mkdir deploy touch deploy/requirements.txt touch deploy/build.sh mkdir deploy/config touch deploy/config/__init__.py touch deploy/config/demo.py mkdir deploy/cron touch deploy/cron/myapp mkdir deploy/docker touch deploy/docker/Dockerfile touch deploy/docker/docker-compose.yml mkdir deploy/nginx touch deploy/nginx/myapp.conf mkdir deploy/uwsgi touch deploy/uwsgi/conf.ini mkdir deploy/uwsgi/conf.d touch deploy/uwsgi/conf.d/myapp.conf

लॉगिंग

यहां आप टेस्ट लॉन्च या एप्लिकेशन के निष्कर्ष के लिए लॉग जोड़ सकते हैं।

 mkdir logs

सहायक स्क्रिप्ट और उपयोगिताओं

 mkdir utils touch utils/useradd.py chmod +x utils/useradd.py

एक निष्कर्ष के बजाय

सिद्धांत रूप में, वह सब है। मैं इतना बड़ा क्यों हूँ? क्योंकि कोड मेरे लिए खुद से बेहतर बोलेंगे। मेरी बाकी टिप्पणियाँ या तो विवाद या विवाद को जन्म दे सकती हैं, जिसके बारे में दृष्टिकोण बेहतर / बदतर होगा।

परियोजना के लिए निर्देशिका संरचना (विशेष रूप से फ्लास्क पर)

जड़

Git