چگونه به عنوان یک توسعه دهنده جدید پایتون عادت های کدنویسی خوب ایجاد کنیم

هنگامی که به عنوان یک توسعه دهنده جدید پایتون شروع به کار می کنید، احتمالاً برخی از عادات خوب و بد را در خود ایجاد خواهید کرد.

کدنویسی چیزی شبیه به هنر است. انعطاف‌پذیری و سفارشی‌سازی تشویق می‌شود – و معمولاً می‌توانید کدی را که می‌خواهید در متن زبان بنویسید.

مشکل این است که شما به صورت عمومی با رایانه ارتباط برقرار می کنید. شما باید کد خود را به گونه ای بنویسید که برای دیگران منطقی باشد.

همچنین، استفاده از نحو نامناسب یا عدم اطمینان از نوشتن موثر می تواند منجر به خطا در برنامه نویسی شما شود. کد کثیف پیدا کردن آن خطاها را بعداً بسیار دشوار می کند. نوشتن خوانا و تمیز راهی است که می توانید پیش بروید، به این معنی که عادات کدنویسی خوب را زودتر شکل دهید روی بنابراین شما آنها را در تمام طول حرفه خود دنبال می کنید.

در اینجا شش نکته برای ایجاد عادات کدنویسی خوب با شروع کار در پایتون آورده شده است.

1. راهنمای سبک PEP 8 را دنبال کنید

کپی رایترها و سایر نویسندگان محتوا معمولاً از چیزی به نام راهنمای سبک استفاده می کنند. یک راهنمای سبک قوانینی را در مورد قالب بندی و سازماندهی متن تنظیم می کند. ممکن است توضیح دهد که آیا از ویرگول آکسفورد استفاده شود یا چه زمانی از سرپوش عنوان و سایر رویکردهای ساختاری استفاده شود.

پایتون یک راهنمای سبک درست مانند این دارد که با نام های PEP 8، PEP8 یا PEP-8 شناخته می شود. چندین توسعه‌دهنده ماهر پایتون این راهنما را در سال 2001 منتشر کردند تا روش نوشتن کد کاملاً خوانا و سازگار را به اشتراک بگذارند.

برخی از اصول عبارتند از:

• استفاده از تکنیک های دندانه سازی مناسب

• کمتر از حداکثر طول خط 79 نویسه باقی بماند.

• استفاده از شکست خط

• استفاده از خطوط خالی – دوتایی یا تکی – برای تعریف توابع، کلاس و متد.

• استفاده از قراردادهای نامگذاری مناسب برای متغیرها، کلاس ها، توابع و غیره روی.

اگر هنوز این کار را نکرده اید، راهنمای سبک Python Pep 8 را بخوانید و مطمئن شوید که از تکنیک ها پیروی می کنید.

2. از جدیدترین نسخه پایتون استفاده کنید

زبان های برنامه نویسی مانند پایتون در طول چرخه زندگی خود تکرارهای زیادی را پشت سر می گذارند. نسخه های قدیمی معمولاً برای نسخه های جدیدتر حذف می شوند. به طور کلی، جدیدترین نسخه شامل رفع اشکال، و همچنین امنیت یا بهبود عملکرد است.

حداقل، از Python 3 بیش از Python 2 استفاده کنید، زیرا نسخه قدیمی‌تر از ژانویه 2020 به وضعیت پایان عمر رسیده است. همچنین، هنگام کار با ماژول‌ها، چارچوب‌ها یا مخازن شخص ثالث، همیشه به حداقل نسخه Python مورد نیاز مراجعه کنید. این قدیمی ترین نسخه پایتون است که با اجزای مرتبط سازگار است.

3. همیشه کد خاص را کامنت کنید

در لحظه ای که در حال نوشتن کد خود هستید، می دانید به چه چیزی می خواهید برسید. وقتی بعداً آن کد را می‌خوانید، ممکن است فراموش کنید – یا بدتر از آن، اگر شخص دیگری آن کد را می‌خواند، ممکن است خودش را گیج کند. نظرات برای همین است.

هر زبان راهی برای «نظر دادن» بخش‌های خاصی از کد دارد. ایده این است که از نظرات توصیفی و در عین حال مختصر برای توضیح آنچه در حال رخ دادن است استفاده کنید. برخی از توسعه دهندگان فراموش می کنند که این کار را به طور کامل انجام دهند، اما اگر زودتر شروع کنید و همیشه از قانون پیروی کنید، می توانید نحوی بنویسید که به راحتی قابل پیگیری است.

در پایتون، شما از نماد “#” در ابتدای کامنت برای کامنت کردن یک خط استفاده می کنید. برای نوشتن یک نظر چند خطی، می توانید از نقل قول های سه گانه (”’) در ابتدا یا پایان یا چندین هشتگ در هر خط استفاده کنید.

#This is a regular comment.

‘’’
This is a multi-line comment.
To explain what the code is doing.
‘’’

نظر دادن می تواند بخش مهمی از کدنویسی باشد process زیرا به شما این امکان را می‌دهد تا ایده‌هایی را که در حال کدنویسی در ذهنتان می‌گذرد، بهتر به خاطر بسپارید و تجسم کنید.

به گفته کارشناسان، دست‌نویسی یادداشت‌ها و سپس رونویسی دیجیتالی آن‌ها از طریق مواردی مانند نظر دادن، حفظ شما را تا ۷۵ درصد بهبود می‌بخشد. این بدان معناست که وقتی اشکالی را کشف می‌کنید یا می‌خواهید بعداً بهبودهایی ایجاد کنید، می‌توانید تکه‌های کد مربوطه را راحت‌تر به خاطر بیاورید.

نظرات درون خطی نیز می توانند در همان خط به عنوان نقطه کد ظاهر شوند. به عنوان مثال:

print (“Hello World. This is my first code.”) # This is how you create an inline comment

4. از Linter استفاده کنید

یک لاینتر پایتون فاصله کد، طول خط و شرایط طراحی مختلف مانند موقعیت آرگومان را بررسی می کند. در نتیجه، کد شما تمیز، سازماندهی شده و به طور مداوم در چندین فایل در پروژه شما نوشته شده است.

به خاطر داشته باشید که یک لینتر با یک قالب‌دهنده یا زیباکننده خودکار متفاوت است – اگرچه در کدنویسی مدرن، یک ابزار ممکن است هر دوی این عملکردهای پشتیبانی را انجام دهد. شما می توانید یک لینتر را به عنوان چیزی که مشکلات عملی را برطرف می کند در مقابل یک فرمت کننده خودکار، که بیشتر استایل را برطرف می کند، در نظر بگیرید.

Linters می‌تواند خطاهای کدنویسی، اشکالات احتمالی، غلط املایی یا مشکلات نحوی، اما ناهماهنگی‌های سبکی مانند روش استفاده از تورفتگی و فاصله را تجزیه و تحلیل و شناسایی کند. فوکوس قالب‌بندی خودکار روی بخش نوشتاری یا سبکی نحو مانند کاما، نقل قول، طول خط مناسب و غیره روی. هر دو مفید هستند، اما شما به ندرت می خواهید بدون یک لینتر کدنویسی کنید.

برخی از نمونه‌هایی از بهترین لینترهای پایتون عبارتند از Pylint، Flake8، Ruff، زنون و رادون و غیره. لینتر مورد استفاده در اسکرین شات زیر Ruff است که از طریق VSCode نصب شده است.

5. تکیه کنید روی توابع و کتابخانه های داخلی

زیبایی پایتون و زبان های مشابه آن این است که شما هرگز از صفر شروع نمی کنید. شما مجبور نیستید تک تک عملکردها یا دستاوردها را خودتان بنویسید – در عوض، می توانید به آن اعتماد کنید روی توابع داخلی، کتابخانه ها، چارچوب ها و مخازن.

توابع داخلی در وقت شما صرفه جویی می کنند، عملکردهای کاری را به شما می دهند و عموماً توسط گروهی از توسعه دهندگان مدیریت می شوند. مهمتر از آن، آنها عملکرد کد و نرم افزار شما را افزایش می دهند. برای مشاهده توابع زبان داخلی می توانید به اسناد رسمی پایتون مراجعه کنید.

برخی از نمونه ها عبارتند از:

• append(): یک مورد را می گیرد و به یک لیست اضافه می کند، یک لیست موجود را با افزودن به آن تغییر می دهد و لیست را یک عدد افزایش می دهد.

• eval(): هر عبارت مشخص شده را طوری ارزیابی می کند که گویی یک عبارت رسمی پایتون است

• id(): برای ارجاع به هویت منحصر به فرد یک شی یا عدد صحیح استفاده می شود

• max(): حداکثر مقدار یک قابل تکرار را از چندین مقدار داده شده برمی گرداند

• print(): متغیرهای متنی را به پایتون نمایش می دهد یا برمی گرداند console

• round(): یک عدد یا مقدار را تا یک رقم اعشار گرد می کند

با استفاده از رایج ترین آموزش مبتدی، زمانی که از print() تابع، چیزی شبیه به این است:

print(“Hello world I am coding.”)

که برمی گردد:

سلام دنیا من در حال کدنویسی هستم

این تابع داخلی همیشه بدون در نظر گرفتن IDE یا محیط کدنویسی مورد استفاده شما شناسایی می شود، که برای همه توابع داخلی از append() تا round() اعمال می شود.

از سوی دیگر، کتابخانه ها متعدد و متنوع هستند – آنها مجموعه های بسیار بزرگتری از کدها یا توابع از پیش نوشته شده هستند. برای استفاده یا ارجاع به کتابخانه ها و عملکردهای آنها، شما فقط import آنها را در اسکریپت پایتون خود قرار دهید. به عنوان مثال می توان به Requests، FastAPI، Asyncio، aiohttp، Tkinter و موارد دیگر اشاره کرد.

6. رفع مشکلات کد در اسرع وقت

هنگام نوشتن کد، اگر متوجه شدید چیزی نادرست است، همان لحظه آن را درست کنید. آن را به تعویق نیندازید یا صبر نکنید تا بعداً آزمایش کنید. ممکن است اشکال یا خطا را به اشتباه درج کنید – و تصور کنید که دوباره نتوانید آن را پیدا کنید. بین 23 تا 42 درصد از زمان یک برنامه نویس به دلیل کد بد تلف می شود، که زمان ارزشمندی است که می توانید در جای دیگری صرف کنید.

بیشتر از همه، باگ‌ها و خطاها در طول زمان ترکیب می‌شوند، بنابراین هر چه بیشتر آن را ترک کنید، احتمال بیشتری دارد که کل بخش‌های کد شما دچار خطا شوند یا از کار بیفتند. بسیاری از IDE ها و linter ها می توانند در این مورد کمک کنند process، به خصوص اگر از ماژول ورود به سیستم به جای چاپ صرف نتایج استفاده می کنید.

ماژول لاگ پایتون وقایع را در زمان اجرا ردیابی می کند – زمانی که یک برنامه در حال اجرا است. در اصل، این به شما امکان می دهد هنگام آزمایش کد خود، مشکلات یا خطاها را شناسایی کنید. ممکن است هشدارهای مربوط به خطاها، اشکال زدایی یا رویدادهای مرتبط با کد را علامت گذاری کند، اما همچنین می تواند به شما در درک رفتار زمان اجرا پروژه خود کمک کند – همه چیزهایی که ممکن است در طول نوشتن نادیده بگیرید. process.

شما می توانید تعاملات کاربر را ببینید و تجزیه و تحلیل کنید، به عنوان مثال، به خصوص اگر کاربران خارجی برنامه شما را آزمایش کنند. مهمتر از همه، ماژول ورود به سیستم یک ابزار حسابرسی است که پس از شروع آزمایش یا اجرای کدی که نوشته‌اید، بسیار ارزشمند است. بدون آن کد نویسی نکنید.

تمرین کامل می کند

هنگام کار با پایتون موارد زیادی وجود دارد که باید در نظر بگیرید و مهم نیست که چقدر مهارت یا مهارت دارید. پیروی از بهترین شیوه های پایتون همیشه راهی برای رفتن است. اما در نهایت، بهترین راه برای یادگیری همیشه گرفتن دست استon رویکرد، که به معنای تمرین است.

حتی برای ایجاد پروژه های ساده یا کوچک برای خود، به استفاده از پایتون ادامه دهید. استفاده از عادات مورد بحث در اینجا و نوشتن کدهای تمیز را تمرین کنید. شما همچنین باید کدهای دیگر توسعه دهندگان را بخوانید تا ببینید چگونه به آن می پردازند process.