Daha İyi Kod için 6 Python En İyi Uygulaması

Python En İyi Uygulamaları 

1. Kod kalitesi için Python en iyi uygulamaları

Okunabilir ve düzenli kod yazmak fark yaratır ve kariyer fırsatlarınızı artırır. Kodlama, yeni başlayanlara mekanik ve karmaşık bir süreç gibi görünse de, gerçekte kodlama bir sanattır. 

Python'da kod kalitesini artırmak için takip edebileceğiniz birçok ipucu vardır. İşte en ilgili olanlardan bazıları.

Girintileme zorunluluğu

Girintileme, bir kod satırının başındaki boşlukları ifade eder. Diğer programlama dillerinde girintileme yalnızca okunabilirlik için bir araçken, Python'da zorunludur. Python, bir kod bloğunu açmak için girintilemeyi kullanır. Daha net olmak gerekirse, aşağıdaki kodda görüldüğü gibi her girinti düzeyi için art arda 4 boşluk kullanılır:

for number in [1,2,3,4]:
    if number % 2 == 0:
        print(number)
    else:
        continue

Maksimum satır uzunluğu

PEP 8, hiçbir satırın 79 karakterden uzun olmamasını önerir. Bunun mantığı şudur: daha kısa satırlar okumayı kolaylaştırır. Ayrıca bu uzunluk, birden fazla dosyayı yan yana açık tutmanıza olanak tanır.

Boş satırlar

Üst düzey fonksiyon ve sınıf tanımlarını iki boş satırla çevreleyin. Bir sınıfın içindeki yöntem tanımları bir boş satırla çevrelenir. İlgili fonksiyon gruplarını ayırmak için (ölçülü şekilde) fazladan boş satırlar kullanılabilir. Son olarak, fonksiyonların içinde mantıksal bölümleri belirtmek için (ölçülü şekilde) boş satırlar kullanın. 

Linter ve otomatik biçimlendiriciler kullanın

Kod ustalığı zaman alır. Kod yazarken tüm ayrıntılara dikkat etmek zor ve zaman alıcı olabilir. Neyse ki makineler, özellikle linter’lar ve biçimlendiriciler, kod kalitesini sağlamamıza yardımcı olabilir. 

Linter’lar kaynak kodun statik analizini yapar ve anlamsal tutarsızlıkları kontrol eder. Biçimlendiriciler ise benzer araçlardır ve kodunuzun boşluklarını, satır uzunluğunu, argüman konumlandırmasını vb. yeniden düzenleyerek farklı dosya veya projeler arasında tutarlı görünmesini sağlamaya çalışır. Python size seçebileceğiniz çok sayıda linter ve biçimlendirici sunar.

İlkeleri akılda tutun

Yukarıda bahsedilen bazı kurallar açık olsa da, kodlama çoğu zaman iyi zevk ve sezgiyle ilgilidir. Bir kodlama sanatçısı olmak için Python'un dayandığı bazı ilkeleri bilmelisiniz. Bu tür ilkelere harika bir örnek, ayrı bir yazıda ele aldığımız Python'un Zen'idir.  

2. Python günlüğe kaydetme (logging) en iyi uygulamaları

Günlüğe kaydetme, bir yazılım çalışırken meydana gelen olayları izleme aracıdır. Özellikle uygulamalar boyut ve karmaşıklık bakımından büyüdükçe, günlükleme geliştirme, hata ayıklama, çalıştırma ve performansı izleme için kritik bir teknik haline gelir.  

logging modülü, günlükleme uygulamalarını ele almak için Python’un Standart Kitaplığı'nın bir parçası olarak sürüm 2.3’ten beri yer almaktadır ve PEP 282'de kapsamlı şekilde açıklanmıştır.

Günlükleme, ruhen Print işlevine benzer. Ancak print işlevi, bir geliştiricinin faydalı bulabileceği pek çok bilgiden yoksundur. Günlükleme ise hatanın meydana geldiği zaman damgalarını ve satır numarasını kaydedebilir. Hataları veya herhangi bir bilgiyi dosyalara, soketlere vb. de yazabilir.

Modülü içe aktarmak için yalnızca şu kodu çalıştırmanız yeterlidir:

import logging

Her günlük mesajı aynı değildir. Nitekim modül, mesajın ciddiyetine göre günlük seviyeleri sunar. Şöyledir:

• NOTSET (0): Tüm mesajların günlüğe kaydedileceği anlamına gelir.
• Debug (10): Koddaki sorunları teşhis etmek için kullanışlıdır. 
• Info (20): Kodda hata olmadığını teyit etmek için kullanılabilir. Bilgi düzeyindeki günlüklemenin iyi bir kullanım alanı, bir makine öğrenmesi modelinin eğitim sürecini izlemektir. 
• Warning (30): Gelecekte meydana gelebilecek bir sorunu gösterir. Örneğin, gelecekte kullanımdan kaldırılabilecek bir modül veya düşük RAM uyarısı için bir uyarı verilebilir. 
• Error (40): Ciddi bir kod hatası; sözdizimi hatası, bellek yetersizliği hatası veya istisnalar olabilir. 
• Critical (50): Programın çalışmayı durdurmasına veya aniden kapanmasına neden olabilecek bir hata.

import logging
logging.info('This message is just informative')
logging.debug('My missions is to provide information about debugging.')
logging.critical("A Critical Logging Message")

Bunu söyledikten sonra, aşağıda Python'da günlüklemeyi ele almak için altı en iyi uygulamanın bir listesi yer almaktadır.  

Print yerine log kullanın

Daha önce, logların print işlevleriyle aynı doğrultuda bilgi sağladığını söylemiştik. Ancak loglar çok daha güçlüdür ve daha ayrıntılı bilgi sunabilir. 

Özellikle günlükleme rutinlerine aşina değilseniz Print işlevine yönelmek cazip gelebilir, ancak loglar her zaman en güvenli seçenektir. Ölçeklenmeye ve karmaşık uygulamaları yönetmeye daha uygundurlar. 

İnternette çok sayıda kılavuz ve dokümantasyon bulunur. Örneğin, bu DataCamp günlükleme eğitimi başlamanız için ihtiyacınız olan şey olabilir.

logging modülünü kullanın 

Bu modül, çoğu Python geliştiricisi için başvurulan seçenektir. Bu da modülün iyi bakımlı olduğu ve sorularınıza her zaman yanıt bulabileceğiniz büyük bir topluluk tarafından desteklendiği anlamına gelir.

Günlükleme seviyesini akıllıca seçin

logging modülü altı farklı mesaj seviyesiyle gelir. Her biri belirli bir amaç için tasarlanmıştır. Onlara ne kadar bağlı kalırsanız, sizin ve kullanıcıların kodunuzda neler olup bittiğini anlaması o kadar kolay olur.

Günlükleme yaparken zaman damgalarını kullanın

Bu, print işlevlerinde bulunmayan logların kritik bir özelliğidir. Bir sorunun nerede ortaya çıktığını bilmenin yanı sıra, ne zaman olduğunu bilmek de önemlidir. Bu durumlarda zaman damgaları en büyük müttefiklerinizdir. Zaman damgalarını yazarken standart biçimi, yani ISO-8601 biçimini kullandığınızdan emin olun.

Günlükleme klasörünü temizleyin

Eski günlük dosyalarını arşivlemek, sıkıştırmak veya silmek ve bellek alanı sorunlarını önlemek için FileHandler yerine TimedRotatingFileHandler gibi RotatingFileHandler sınıflarını kullanın. Bu sınıflar, bir boyut sınırı veya zaman koşulu tetiklendiğinde alanı temizler.

3. Python yorum satırı en iyi uygulamaları

Yorumlar, kodumuzun gelecekteki okuyucuları için notlar düşmek açısından çok önemlidir. Kodun nasıl yorumlanması gerektiğini tanımlamak zor olsa da, izleyebileceğimiz bazı yönergeler vardır: 

• Koda aykırı herhangi bir yorum, hiç yorum olmamasından daha kötüdür. Bu nedenle tutarsızlık oluşturmamak için kodu ve yorumları güncellemek çok önemlidir. 
• Yorumlar tam cümleler olmalı ve ilk harfi büyük olmalıdır. 
• Yorumları İngilizce yazmaya çalışın. Herkes yorumlarını uygun gördüğü dilde yazmakta özgür olsa da, İngilizce yazılması tavsiye edilir. 
• Yorumlarınızın, yazdığınız dili konuşan diğer kişiler için açık ve kolay anlaşılır olmasını sağlayın.

İki tür yorum vardır: blok yorumlar ve satır içi yorumlar. 

Bir blok yorum, kendisinden sonra gelen kodu açıklar. Genellikle blok yorumu kod bloğuyla aynı düzeyde girintilersiniz. Bir blok yorumun her satırı # ve bir boşlukla başlar, şu şekilde:

# This is a block comment
print('Welcome to DataCamp!")

Öte yandan, satır içi yorumlar kodla aynı satırda görünür. Satır içi yorumlar, ifadeden en az iki boşlukla ayrılmalıdır. Blok yorumuna benzer şekilde, bir satır içi yorum tek bir kare işareti (#) ile başlar, ardından bir boşluk ve bir metin dizesi gelir. 

print ("Have you ever tried Python?") # This is an inline comment

4. Python docstring en iyi uygulamaları

Docstring, bir modül, fonksiyon, sınıf veya yöntem tanımında ilk ifade olarak yer alan bir dize sabitidir. Genellikle, kod dokümantasyonunu otomatik olarak oluşturmak için bir dokümantasyon dizesi kullanırsınız. Bu nedenle bir docstring, çalıştırma sırasında o nesnenin obj.__doc__ özel niteliği kullanılarak erişilebilir.

Tutarlılık için docstring’ler her zaman üç çift tırnak (""") içine alınır.

Docstring’lerin iki biçimi vardır: tek satırlık ve çok satırlı docstring’ler. Tek satırlıklar gerçekten bariz durumlar içindir. Gerçekten tek satıra sığmalıdırlar. Aşağıdaki örnek, multiply() fonksiyonunda tek satırlık bir docstring’i gösterir:

def multiply(x, y):
    """ Return the product of two numbers """
    result = x * y
    return result

Öte yandan, çok satırlı bir docstring birden fazla satıra yayılabilir. Böyle bir docstring, betiğin işlevini, komut satırı sözdizimini, ortam değişkenlerini ve dosyaları belgelendirmelidir. Kullanım iletileri oldukça ayrıntılı olabilir ve yeni bir kullanıcının komutu doğru şekilde kullanması için yeterli olmalıdır.

def calculate_salary(hours, price=20):
    """ Return the salary according to the hours worked

    Arguments:
    hours: total hours investe
    price: price of each hours worked. Minimum price is 20 dollars
    """
    salary = hours * price
    return salary

Docstring’lere ilişkin daha ayrıntılı bir açıklama PEP257'de bulunabilir.

5. Python dokümantasyon en iyi uygulamaları

Yorumlar, birlikte çalıştığınız diğer geliştiricilerin kodunuzu anlaması için önemliyken, dokümantasyon potansiyel kullanıcı topluluğunun yazılımınızı kullanmayı öğrenmesine yardımcı olmayı amaçlar. Bu kritik bir adımdır: Yazılımınız ne kadar iyi olursa olsun, dokümantasyon yeterince iyi değilse, ya da daha da kötüsü eksikse, insanlar onu kullanmayacaktır. 

Özellikle yeni bir projede çalışıyorsanız bir README dosyası eklemek her zaman iyi bir uygulamadır. Bu dosyalar genellikle kodunuzun okuyucuları için ana giriş noktasıdır ve hem kullanıcılar hem de proje bakıcıları için genel bilgileri içerir. 

Kısa olmakla birlikte, README dosyası projenin amacını, yazılımın ana kaynağının URL’sini ve kredi bilgilerini açıklamalıdır.

Aynı şekilde, yazılımın veya kitaplığın Python modüllerini dağıtmanın standardı olan Distutils ile paketlenip dağıtıldığından emin olmak için her zaman bir setup.py dosyası eklemelisiniz.

Ayrıca, yazılımınızın çalışması için başka bağımlılıklar veya paketler gerekiyorsa, gerekli bağımlılıkları ve sürümlerini açıklayan bir requirements.txt dosyası eklemelisiniz.

Son olarak, potansiyel kullanıcılar için ilgili olduğunu düşündüğünüz diğer tüm bilgileri eklemekte özgürsünüz. Örneğin, paketinizin veya fonksiyonlarınızın nasıl çalıştığına dair örnekler sunmak iyi bir uygulamadır. 

6. Python sanal ortam en iyi uygulamaları 

Veri projelerinizde düzen ve tutarlılığı sağlamak için, başladığınız her proje için bir sanal ortam oluşturmak iyi bir uygulamadır. 

Sanal ortamlar, diğer adıyla virtualenv’ler, Python ve projeniz için gereken kitaplıkların sürümlerini ve bunlarla ilişkili pip sürümlerini ayırmanıza ve yalıtmanıza yardımcı olur. Bu sayede son kullanıcılar, sistemin sağladıklarından bağımsız olarak kendi yazılım ve sürüm setlerini yükleyip yönetebilir. 

Sanal ortam oluşturmak için önce gerekli paketi yüklememiz gerekir; terminalinize aşağıdaki kod satırını yazın:

pip install virtualenv

Yeni bir sanal ortam oluşturmak için sihri gerçekleştirecek kod aşağıdadır. Yeni sanal ortama “new_venv” adını veriyoruz

python3 -m venv /path/to/new/virtual/environment/new_venv

Python Adlandırma Kuralları

Yeni başlayan Python geliştiricileri arasında en yaygın hatalardan biri, değişkenlerin, sınıfların, fonksiyonların vb. yanlış adlandırılmasıdır. Adlandırma kuralları, kodun okunabilirliğini sağlamak için kritik unsurlardır.

PEP 8, Python'da nesnelerin standart şekilde nasıl adlandırılacağını açıklar. Yönergelere göre, yeni modüller ve paketler (üçüncü taraf çerçeveler dahil) bu standartlara göre yazılmalıdır, ancak mevcut bir kitaplığın farklı bir stili varsa dahili tutarlılık tercih edilir.

Çok genel veya günlük dile ait isimler kullanmaktan kaçınmalısınız. Ayrıca standart kitaplıkta kullanılan tanımlayıcılar, PEP 3131'de açıklandığı gibi ASCII ile uyumlu olmalıdır.

# Bad naming:
data_structure, ríos_españa, dictionary_with_countries_and_capitals
# Good naming:
user_profile, stop_words, global_emissions_df

Aşağıda Python'daki en yaygın nesneler için adlandırma kurallarının bir listesi yer almaktadır.

• Paketler ve modüller
• Paket ve modül adları tamamen küçük harf olmalıdır
• Paket ve modül adında alt çizgi yalnızca okunabilirliği artırıyorsa kullanılmalıdır.
• Sınıflar
• Sınıf adları UpperCaseCamelCase kuralını izlemelidir
• Bununla birlikte, Python’un yerleşik sınıfları genellikle küçük harfli sözcüklerdir
• Örnek değişkenler, yöntemler ve fonksiyonlar
• Örnek değişken adları tamamen küçük harf olmalıdır
• Değişken örneklerine yeni kelimeler eklemek için alt çizgi kullanın
• Genel olmayan örnek değişkenler tek bir alt çizgi ile başlamalıdır
• Sabitler
• Sabit adları tamamen büyük harfle yazılmalıdır
• Sabitlere yeni kelimeler eklemek için alt çizgi kullanın

Sonuç

Python en iyi uygulamalarında ustalaşmak, temiz, verimli ve sürdürülebilir kod yazmak için gereklidir. Kod kalitesi, günlükleme, yorumlama ve dokümantasyona ilişkin yönergeleri izleyerek ve sanal ortamlar gibi araçlar kullanarak projelerinizin yönetilmesini, birlikte çalışılmasını ve ölçeklendirilmesini kolaylaştırabilirsiniz.

Python becerilerinizi geliştirmeye devam ederken, Python ve geniş uygulama yelpazesine ilişkin anlayışınızı derinleştirmek için daha kapsamlı öğrenme kaynaklarını keşfetmeyi düşünün. Yapılandırılmış bir rehberlik arıyorsanız, şu kaynaklara göz atın:

• Python Nasıl Öğrenilir: Uzmanlığa Giden Rehber – Bu uzman rehberi, Python’u öğrenme sürecinde size yol gösterecek; dili ustalaşmak için ipuçları ve teknikler sunar.
• Geliştiriciler için Python’a Giriş – Python’a başlamak isteyen geliştiriciler için ideal olan bu kurs, dilin temel kavramlarını ve özelliklerini pratik, uygulamalı bir şekilde kapsar.
• Python ile Veri Bilimine Giriş – Python’la kendinizi rahat hissetmeye başladığınızda, bu başlangıç dostu kursla veri bilimine dalın. Python’da verilerle çalışmak için temel kütüphaneleri ve teknikleri kapsar.