Flask में SQLAlchemy attribute event से NoneType lower त्रुटि को कैसे ठीक करें

Flask/SQLAlchemy में email सेट पर NoneType lower AttributeError का कारण और हल: attribute event की टाइमिंग, कंस्ट्रक्टर में हैश, सुरक्षित compute_avatar.

Flask एप्लिकेशन में नया उपयोगकर्ता जोड़ते ही अचानक AttributeError: 'NoneType' object has no attribute 'lower' आने लगा? अगर आपका मॉडल ईमेल से Gravatar का हैश निकालता है और आप उस गणना को ट्रिगर करने के लिए SQLAlchemy के attribute events पर भरोसा करते हैं, तो समस्या संभवतः इवेंट के चलने के समय से आती है, न कि हैश फ़ंक्शन से।

समस्या को दोहराकर देखना

पैटर्न मोटे तौर पर ऐसा दिखता है: मॉडल एक email कॉलम और एक avatar हैश घोषित करता है, हैश को एक हेल्पर मेथड में निकालता है, और कॉलम के set इवेंट पर एक लिस्नर जोड़ता है ताकि ईमेल असाइन होने पर हैश सिंक में रहे।

class Account(db.Model):
    __tablename__ = 'accounts'
    id = db.Column(db.Integer, primary_key=True)
    contact_email = db.Column(db.String(128), unique=True, index=True)
    avatar_digest = db.Column(db.String(32))
    def __init__(self, **fields):
        super(Account, self).__init__(**fields)
        # ... अन्य प्रारंभिक सेटअप
    def compute_avatar(self):
        return hashlib.md5(self.contact_email.lower().encode('utf-8')).hexdigest()
    @staticmethod
    def handle_email_set(target, value, oldvalue, initiator):
        # यहाँ असफल होता है जब target.contact_email अभी भी None होता है
        target.avatar_digest = target.compute_avatar()
db.event.listen(Account.contact_email, 'set', Account.handle_email_set)

contact_email सेट करके मॉडल को instantiate करना सीधा लगता है, फिर भी lower() की पहली कॉल इवेंट हैंडलर के अंदर से आती है और क्रैश हो जाती है, क्योंकि उस क्षण contact_email अभी भी None होता है।

वास्तव में क्या गलत हो रहा है

समस्या हैशिंग या स्ट्रिंग हैंडलिंग की नहीं, टाइमिंग की है। मैप्ड एट्रिब्यूट पर set इवेंट उस समय फायर होता है जब ऑब्जेक्ट अभी इनिशियलाइज़ ही हो रहा होता है। लिस्नर चलते ही जब हैश हेल्पर को कॉल करता है, तो इंस्टैंस पर एट्रिब्यूट को अभी तक वह वैल्यू नहीं मिली होती जो आपने पास की थी; नतीजतन मेथड None पढ़ता है और उस पर lower() कॉल करने की कोशिश करता है, जिससे AttributeError उठता है।

इसे कैसे ठीक करें

रेस कंडीशन से बचने का सबसे आसान तरीका है अवतार हैश को तब निकालना जब ऑब्जेक्ट बन चुका हो और ईमेल निश्चित रूप से उपलब्ध हो। यानी असाइनमेंट को लिस्नर से हटाकर कंस्ट्रक्टर में ले जाएँ और एक सरल जाँच (sanity check) से सुरक्षित करें।

class Account(db.Model):
    __tablename__ = 'accounts'
    id = db.Column(db.Integer, primary_key=True)
    contact_email = db.Column(db.String(128), unique=True, index=True)
    avatar_digest = db.Column(db.String(32))
    def __init__(self, **fields):
        super(Account, self).__init__(**fields)
        # फ़ील्ड बाँधने के बाद, संभव हो तो व्युत्पन्न मान निकालें
        if self.contact_email is not None and self.avatar_digest is None:
            self.avatar_digest = self.compute_avatar()
    def compute_avatar(self):
        return hashlib.md5(self.contact_email.lower().encode('utf-8')).hexdigest()

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

class Account(db.Model):
    __tablename__ = 'accounts'
    id = db.Column(db.Integer, primary_key=True)
    contact_email = db.Column(db.String(128), unique=True, index=True)
    avatar_digest = db.Column(db.String(32))
    def __init__(self, **fields):
        super(Account, self).__init__(**fields)
        if self.contact_email is not None and self.avatar_digest is None:
            self.avatar_digest = self.compute_avatar()
    def compute_avatar(self):
        if self.contact_email is None:
            return None
        return hashlib.md5(self.contact_email.lower().encode('utf-8')).hexdigest()

जब आप attribute events पर निर्भर करते हैं, तो समझ लें कि इस बिंदु पर बदलाव सुनना उस एट्रिब्यूट के लिए उपयुक्त नहीं है, अगर हैंडलर मान लेता है कि वैल्यू पहले से इंस्टैंस पर सेट है। इनिशियलाइज़ेशन के बाद गणना ट्रिगर करने से NoneType एक्सेस से बचाव होता है।

यह क्यों मायने रखता है

ORM के लाइफसाइकल हुक शक्तिशाली होते हैं, लेकिन वे उम्मीद से पहले भी फायर हो सकते हैं। कॉलम इवेंट्स को ऐसे मानना कि जैसे इंस्टैंस पूरी तरह आबाद हो चुका है, कोड को नाज़ुक बना देता है और ऐसी रुक-रुक कर आने वाली त्रुटियाँ पैदा करता है जो केवल नए ऑब्जेक्ट बनाते समय दिखती हैं। SQLAlchemy कब इवेंट्स भेजता है, यह समझना मदद करता है तय करने में कि व्युत्पन्न फ़ील्ड्स को __init__ में, स्पष्ट setters में, या ऐसे स्थान पर गणना करें जहाँ डेटा निश्चित रूप से मौजूद हो।

मुख्य बातें

व्युत्पन्न मानों को उन अवस्थाओं पर निर्भर रखें जिन पर आपका नियंत्रण हो। अगर किसी मान को ईमेल चाहिए, तो उसे कंस्ट्रक्टर द्वारा कीवर्ड आर्ग्युमेंट बाँधने के बाद निकालें। और अगर बाद में दोबारा गणना की ज़रूरत पड़े, तो हेल्पर में रक्षात्मक जाँच जोड़ें ताकि वह अस्थायी None को सह सके। और जब बग स्पष्ट न हो, तो उस असफल पथ को ऐसे न्यूनतम स्निपेट तक सीमित करें जो ठीक-ठीक दिखाए कि एट्रिब्यूट कब उपलब्ध होता है।