अजगर विन्यास फाइल

कॉन्फ़िगरेशन। सभी उन्हें अलग-अलग तरीकों से स्टोर करते हैं। किसी ने .yaml , किसी ने .ini , और किसी ने सोर्स कोड में, यह सोचते हुए कि "Django पाथ" को अपनी settings.py साथ वास्तव में अच्छा किया है।

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

प्रयास नंबर 1

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

इस शैली में एक विशिष्ट विन्यास इस तरह दिखता है:

 # settings.py TWITTER_USERNAME="johndoe" TWITTER_PASSWORD="johndoespassword" TWITTER_TOKEN="......." 

यह अच्छा लग रहा है। केवल एक चीज की चिंता है, सुरक्षा डेटा कोड में क्यों संग्रहीत हैं? हम यह कैसे करेंगे? पहेली। सिवाय हमारी फाइल को .gitignore में .gitignore करने के, लेकिन यह, बिल्कुल, एक समाधान नहीं है।

वैसे भी, कम से कम कुछ डेटा कोड में क्यों संग्रहीत किया जाता है? जैसा कि कोड मुझे लगता है, यह एक कोड भी है जिसे किसी प्रकार के तर्क को निष्पादित करना चाहिए, और डेटा को संग्रहीत नहीं करना चाहिए।

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

इसके बारे में थोड़ा और ।

प्रयास नंबर 2

खैर, जब से हमने फैसला किया कि कोड में डेटा संग्रहीत करना अच्छा नहीं है, चलो एक विकल्प की तलाश करें। कॉन्फ़िगरेशन फ़ाइलों के लिए बहुत से अलग-अलग स्वरूपों का आविष्कार किया गया है, toml बहुत लोकप्रियता हासिल की है।

लेकिन हम शुरुआत करेंगे जो पायथन खुद हमें प्रदान करता है - .ini मानक पुस्तकालय में एक configparser पुस्तकालय है।

हमारा कॉन्फ़िगरेशन, जिसे हमने पहले ही लिखा था:

 # settings.ini [Twitter] username="johndoe" password="johndoespassword" token="....." 

अब पायथन में पढ़ें:

 import configparser #   config = configparser.ConfigParser() #    config.read("settings.ini") #   print(config["Twitter"]["username"]) #     ! # 'johndoe' 

सभी समस्याओं का समाधान किया जाता है। डेटा कोड में संग्रहीत नहीं है, पहुंच आसान है। लेकिन ... और अगर हमें अन्य yaml को पढ़ने की ज़रूरत है, तो वहाँ उदाहरण के लिए, या एक ही बार में json या yaml । बेशक, मानक पुस्तकालय और pyyaml में json है, लेकिन आपको इसके लिए (अच्छी तरह से, या वास्तव में नहीं) कोड का एक गुच्छा लिखना होगा।

प्रलेखन ।

प्रयास नंबर 3

और अब, मैं आपको अपनी लाइब्रेरी दिखाना चाहता हूं, जिसे इन सभी समस्याओं को हल करने के लिए बनाया गया है (अच्छी तरह से, या कम से कम अपने दुख को कम करें :))।

इसे betterconf कहा जाता है और यह PyPi पर उपलब्ध है।

स्थापना किसी भी अन्य पुस्तकालय की तरह सरल है:

 pip install betterconf 

प्रारंभ में, हमारे कॉन्फ़िगरेशन को फ़ील्ड के साथ एक वर्ग के रूप में प्रस्तुत किया जाता है:

 # settings.py from betterconf import Config, field class TwitterConfig(Config): #  ,    `Config` username = field("TWITTER_USERNAME", default="johndoe") #   `username`,    ,   password = field("TWITTER_PASSWORD", default="johndoespassword") #  token = field("TWITTER_TOKEN", default=lambda: raise RuntimeError("Account's token must be defined!") #   ,      cfg = TwitterConfig() print(cfg.username) # 'johndoe' 

डिफ़ॉल्ट रूप से, लाइब्रेरी पर्यावरण चर से मान लेने की कोशिश करती है, लेकिन हम इसे भी कॉन्फ़िगर कर सकते हैं:

 from betterconf import Config, field from betterconf.config import AbstractProvider import json class JSONProvider(AbstractProvider): #     SETTINGS_JSON_FILE = "settings.json" #      def __init__(self): with open(self.SETTINGS_JSON_FILE, "r") as f: self._settings = json.load(f) #    def get(self, name): return self._settings.get(name) #    -  ,  - None.     ,   None. provider = JSONProvider() class TwitterConfig(Config): username = field("twitter_username", provider=provider) #      # ... cfg = TwitterConfig() # ... 

इस उदाहरण से यह निम्न है कि हम डेटा प्राप्त करने के लिए विभिन्न प्रदाताओं का उपयोग कर सकते हैं। और यह वास्तव में कभी-कभी सुविधाजनक होता है, मैं व्यक्तिगत अनुभव से कहता हूं।

ठीक है, अगर हमारे पास बूलियन मान या संख्याओं के विन्यास हैं, तो वे अंततः तार में आएंगे। और इसके लिए एक उपाय है:

 from betterconf import Config, field #     2  from betterconf.caster import to_bool, to_int class TwitterConfig(Config): # ... post_tweets = field("TWITTER_POST_TWEETS", caster=to_bool) # ... 

इस प्रकार, बूलियन प्रकारों के समान सभी मूल्य (अर्थात् true और false को पायथन bool बदल दिया जाएगा। मामला केस-संवेदी नहीं है।

अपना ढलाईकार लिखना भी आसान है:

 from betterconf.caster import AbstractCaster class DashToDotCaster(AbstractCaster): def cast(self, val): return val.replace("-", ".") #     to_dot = DashToDotCaster() # ... 

अधिक विस्तृत प्रलेखन के साथ Github भंडार ।

परिणाम

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

पुनश्च

हां, आप Pydantic को भी शामिल कर सकते हैं, लेकिन मेरा मानना ​​है कि यह इस तरह के कार्यों के लिए बहुत हल्का है।