Jak zaprojektować klasę w Pythonie?

Poniższe Rady (podobne do rad @S. Lott) pochodzą z książki, Beginning Python: From Novice to Professional

1. Napisz opis swojego problemu (co powinien zrobić problem?). Podkreśl wszystkie rzeczowniki, czasowniki i przymiotniki.

2. Przejrzyj rzeczowniki, szukając potencjalnych klas.

3. Przejrzyj czasowniki, szukając potencjalnych metod.

4. Przejść przez przymiotniki, szukając potencjału atrybuty

5. Przydziel metody i atrybuty do klas

Aby udoskonalić klasę, książka radzi również, abyśmy mogli wykonać następujące czynności:

1. Zapisz (lub wymyśl) zestaw przypadków użycia - - - scenariuszy, w jaki sposób twój program może być używany. Spróbuj pokryć wszystkie funkcjonalnie.

2. Przemyśl krok po kroku każdy przypadek użycia, upewniając się, że wszystko, czego potrzebujemy, jest pokryte.

Podoba mi się podejście TDD... Zacznij więc od pisania testów, jakie chcesz, aby zachowanie było. I napisz kod, który przejdzie. W tym momencie nie martw się zbytnio o projekt, po prostu zdobądź pakiet testowy i oprogramowanie, które przejdzie. Nie martw się, jeśli skończysz z jedną wielką brzydką klasą, ze złożonymi metodami.

Czasami, podczas tego początkowego procesu, można znaleźć zachowanie, które jest trudne do przetestowania i wymaga rozkładu, tylko dla testowalności. Może to być wskazówka, że oddzielna klasa jest / align = "left" /

Potem zabawa... refaktoryzacja. Po zainstalowaniu działającego oprogramowania możesz zobaczyć złożone elementy. Często małe kieszenie zachowań staną się widoczne, sugerując nową klasę, ale jeśli nie, po prostu poszukaj sposobów na uproszczenie kodu. Wyodrębnij obiekty usługowe i Obiekty wartości. Uprość swoje metody.

Jeśli używasz git poprawnie (używasz git, prawda?), można bardzo szybko eksperymentować z jakimś konkretnym rozkładem podczas refaktoryzacji, a następnie zrezygnować to i wrócić z powrotem, jeśli to nie uprości rzeczy.

Pisząc testowany kod roboczy najpierw powinieneś uzyskać intymny wgląd w problemową dziedzinę, której nie możesz łatwo uzyskać dzięki podejściu design-first. Pisanie testów i kodu popycha cię do paraliżu "od czego zacząć".

Cała idea OO design polega na tym, aby Twój kod mapował się do twojego problemu, więc gdy np. chcesz pierwszy krok psa, robisz coś w stylu:

dog.footstep(0)

Teraz może być tak, że w Twoim przypadku musisz przeczytać w pliku surowych danych i obliczyć lokalizacje kroków. Wszystko to może być ukryte w funkcji footstep() tak, że dzieje się to tylko raz. Coś w stylu:

 class Dog:
   def __init__(self):
     self._footsteps=None 
   def footstep(self,n):
     if not self._footsteps:
        self.readInFootsteps(...)
     return self._footsteps[n]

[jest to teraz rodzaj wzorca buforowania. Pierwszy raz idzie i odczytuje dane kroków, kolejne czasy po prostu dostaje to od siebie._footsteps.]

Pisanie rzeczowników, czasowników, przymiotników jest świetnym podejściem, ale wolę myśleć o projektowaniu klas jako zadaniu pytania jakie dane powinny być ukryte ?

Imagine you had a Query object and a Database object:

Obiekt Query pomoże Ci utworzyć i zapisać zapytanie -- store, jest tutaj kluczem, ponieważ funkcja może pomóc Ci utworzyć takie samo łatwo. Może mógłbyś zostać: Query().select('Country').from_table('User').where('Country == "Brazil"'). Nie ma znaczenia składnia-to Twoja praca! -- kluczem jest obiekt pomaga ukryć coś , w tym przypadku dane niezbędne do przechowywania i wypisywania zapytania. Moc obiektu wynika ze składni używania go (w tym przypadku sprytnego chaining) i nie konieczności wiedzieć, co przechowuje, aby działał. Jeśli zrobi się to poprawnie, obiekt Query może wysyłać zapytania do więcej niż jednej bazy danych. Wewnętrznie przechowywałby określony format, ale mógłby łatwo konwertować do innych formatów podczas wysyłania (Postgres, MySQL, MongoDB).

A teraz Przemyśl obiekt Database. Co to ukrywa i przechowuje? Cóż, najwyraźniej nie może przechowywać pełnej zawartości bazy danych, ponieważ dlatego mamy bazę danych! Więc jaki to ma sens? Celem jest ukrycie działania bazy danych przed osobami używającymi obiektu Database. Dobre klasy uproszczą rozumowanie podczas manipulowania stanem wewnętrznym. Dla tego obiektu Database można ukryć sposób działania połączeń sieciowych, zapytań wsadowych lub aktualizacji, lub dostarczyć warstwę buforowania.

The problem w tym, że obiekt Database jest ogromny. Reprezentuje sposób dostępu do bazy danych, więc pod przykrywką może zrobić wszystko i wszystko. Oczywiście sieci, buforowanie i grupowanie są dość trudne do opanowania w zależności od systemu, więc ukrywanie ich byłoby bardzo pomocne. Ale, jak wiele osób zauważy, baza danych jest szalenie złożona, a im dalej od surowych wywołań DB otrzymujesz, tym trudniej jest dostroić się do wydajności i zrozumieć, jak to działa.

To jest fundamentalne wymiana OOP. Jeśli wybierzesz odpowiednią abstrakcję, kodowanie będzie prostsze (ciąg znaków, tablica, Słownik), jeśli wybierzesz zbyt dużą abstrakcję (baza danych, EmailManager, NetworkingManager), może stać się zbyt skomplikowane, aby naprawdę zrozumieć, jak to działa lub czego się spodziewać. Celem jest ukrycie złożoności , ale pewna złożoność jest konieczna. Dobrą zasadą jest, aby zacząć od unikania Manager obiektów, a zamiast tego tworzyć klasy, które są jak structs - wszystko, co robią, to przechowują dane, z niektórymi metody pomocnicze do tworzenia / manipulowania danymi, aby ułatwić sobie życie. Na przykład, w przypadku EmailManager zacznij od funkcji o nazwie sendEmail, która zajmuje obiekt Email. Jest to prosty punkt wyjścia, a kod jest bardzo łatwy do zrozumienia.

Jeśli chodzi o twój przykład, zastanów się, jakie dane muszą być razem, aby obliczyć, czego szukasz. Jeśli chcesz wiedzieć, jak daleko zwierzę idzie, na przykład, możesz mieć klasy AnimalStep i AnimalTrip (kolekcja AnimalSteps). Teraz, gdy każda podróż ma wszystkie dane o krokach, powinna być w stanie dowiedzieć się o tym, być może {16]} ma sens.

Po sprawdzeniu twojego linkowanego kodu, wydaje mi się, że lepiej Ci będzie , a nie w tym momencie projektować klasę psów. Zamiast tego należy używać pand i dataframes . Ramka danych jest tabelą z kolumnami. Macie takie kolumny jak: dog_id, contact_part, contact_time, contact_location, itd. Pandy używa tablic Numpy za kulisami i ma wiele wygodnych metod dla Ciebie: {]}

• wybierz psa np.: my_measurements['dog_id']=='Charly'
• Zapisz dane: my_measurements.save('filename.pickle')
• rozważ użycie pandas.read_csv() zamiast ręcznego czytania plików tekstowych.