Prośba o krytykę jakości napisanego kodu

Prośba o krytykę jakości napisanego kodu
DA
  • Rejestracja:ponad 13 lat
  • Ostatnio:ponad 9 lat
  • Postów:52
0

Cześć. Od razu mówię, że proszę o poświęcenie mi trochę czasu, więc jeśli ktoś nie ma ochoty pomagać to niech nie pomaga i proszę o wyrozumiałość - chcę się czegoś nauczyć. Wstawiam krótki kod w języku Python. Ponieważ dopiero się go uczę i nie znam go na wylot, to bardzo prosiłbym o jakieś wskazówki odnośnie kodu. Kod to rozwiązanie zadania z konkursu programistycznego
sprzed kilku lat stąd dziwne nazwy jak Bajtazar, bo takie imię było w poleceniu do zadania. Z góry dziękuję za poświęcony mi czas :)

treść zadania jeśli ktoś chce ("AUTOMAT"): http://amppz.mimuw.edu.pl/amppz2012-tresci-zadan.pdf
kod: http://pastebin.com/Ex34eE66

Kopiuj
class Bar:
    pass

class Choice:
    pass

#file with input data
tmpFile = open("Pyfood.txt", "r")

barsKinds, BajtazarsMoney = [int(x) for x in tmpFile.readline().split(" ")]
barsPrices = [int(x) for x in tmpFile.readline().split(" ")]
barsAmount = [int(x) for x in tmpFile.readline().split(" ")]

barsList = []

for x in range(barsKinds):
    newBar = Bar()
    newBar.price = barsPrices[x]
    newBar.amount = barsAmount[x]
    barsList.append(newBar)


def findBestOneToBuy(barsList):
    """ Finds best bar to buy (with biggest profit) and returns this as a structure Choice """
    bestChoice = Choice()
    bestChoice.idx = 0 
    bestChoice.profit = 0

    for x in range(len(barsList)): #check every possible condition
        tmpChoice = Choice()
        tmpChoice.idx = x
        tmpChoice.profit = 0

        if (barsList[x].amount == 0 or
            barsList[x].price > BajtazarsMoney) : continue 

        moneySaved = 0
        moneySpent = 0
        
        for i in range(x):  # for every possible condition count profit
            print(i)
            if barsList[i].amount > 0 : moneySaved += barsList[i].price

        moneySaved += barsList[x].price
        moneySpent = barsList[x].price
        tmpChoice.profit = moneySaved/moneySpent

        if tmpChoice.profit > bestChoice.profit : bestChoice = tmpChoice
        print(tmpChoice.profit)

    return bestChoice


def buyBar(idx, barsList):
    """ Takes idx of bar you want to buy and decreases amounts of 
    bars in barsList. returns price to pay and totalValue of stolen goods
    as a tuple """
    totalValue = 0
    for bar in range(idx):
        if barsList[bar].amount >0 :
            barsList[bar].amount -= 1
            totalValue += barsList[bar].price
    
    totalValue += barsList[idx].price
    barsList[idx].amount -= 1
    return barsList[idx].price, totalValue


moneyGained = 0
while True:
    barToBuy = findBestOneToBuy(barsList)
    print("chosen", barToBuy.idx+1)
    if barsList[barToBuy.idx].price > BajtazarsMoney : break

    moneySpent, tmpMoney = buyBar(barToBuy.idx, barsList)
    
    BajtazarsMoney -= moneySpent
    moneyGained += tmpMoney

print(moneyGained)

głównie zależy mi na wskazówkach typu:
"to i to jest nieczytelne"
"tego i tamtego nie powinno się używać" etc.

Mam nadzieję, że wiecie o co mi chodzi. Niestety nie mam nikogo, kto mógłby mi na miejscu dawać takie rady, więc męczę was. Jeszcze raz dziękuję :)

wklejenie kodu do posta - @furious programming

edytowany 1x, ostatnio: flowCRANE
vpiotr
  • Rejestracja:ponad 13 lat
  • Ostatnio:prawie 3 lata
1
  1. Formatowanie. Przeczytaj PEP 8 (zwłaszcza "Pet Peeves")

https://www.python.org/dev/peps/pep-0008/

  1. Nazewnictwo:
Kopiuj
tmpFile = open("Pyfood.txt", "r")

Dlaczego "tmp"?

  1. Klasa-nie klasa

W funkcji findBestOneToBuy zwracasz niby-klasę (obiekt z przypisanymi na biegu atrybutami).
Ale w funkcji buyBar zwracasz już parę liczb. Skąd różnica? Umiesz uzasadnić?

edytowany 1x, ostatnio: vpiotr
DA
tmpFile było takie, ponieważ chciałem potem zrezygnować z tego, żeby dane były wprowadzane z pliku (wczytywanie z pliku skaracało mi czas sprawdzania poprawności programu), ale tego nie zrobiłem, a nazwy zmiennej nie poprawiłem, jakoś mi to umknęło, mój błąd. Jeżeli chodzi o różnicę w tym że raz zwracam tę klasę, a raz krotkę, to zrobiłem tak, ponieważ chciałem użyć tej niby klasy cos na wzór struktury z języka C (gdzieś w jakimś tutorialu czytałem, że tak się robi), dlatego nie chciałem dodawać nowych pól do klasy, ale już wiem, że nie powinienem tego w ogóle robić. Dzięki
Shalom
  • Rejestracja:około 21 lat
  • Ostatnio:prawie 3 lata
  • Lokalizacja:Space: the final frontier
  • Postów:26433
2

Punkt ode mnie: NIE rób tak klas! Serio! Jak piszesz klasę to zrób w niej normalny konstruktor i wylistuj tam pola obiektu. Takie "dodawanie" pól do obiektu na gorąco co prawda "działa", ale w większym projekcie to byś osiwiał jakbyś w ten sposób pracował...


"Nie brookliński most, ale przemienić w jasny, nowy dzień najsmutniejszą noc - to jest dopiero coś!"
Wizzie
  • Rejestracja:prawie 11 lat
  • Ostatnio:ponad 7 lat
2

Najważniejsze jest chyba to, co napisał @Shalom.

Ode mnie nazewnictwo zmiennych i funkcji. Używasz camelCase i nie jest to oczywiście błąd, ale w Pythonie przyjęło się zapisywać je w taki sposób: foo_bar.
https://www.python.org/dev/peps/pep-0008/#prescriptive-naming-conventions

Kliknij, aby dodać treść...

Pomoc 1.18.8

Typografia

Edytor obsługuje składnie Markdown, w której pojedynczy akcent *kursywa* oraz _kursywa_ to pochylenie. Z kolei podwójny akcent **pogrubienie** oraz __pogrubienie__ to pogrubienie. Dodanie znaczników ~~strike~~ to przekreślenie.

Możesz dodać formatowanie komendami , , oraz .

Ponieważ dekoracja podkreślenia jest przeznaczona na linki, markdown nie zawiera specjalnej składni dla podkreślenia. Dlatego by dodać podkreślenie, użyj <u>underline</u>.

Komendy formatujące reagują na skróty klawiszowe: Ctrl+B, Ctrl+I, Ctrl+U oraz Ctrl+S.

Linki

By dodać link w edytorze użyj komendy lub użyj składni [title](link). URL umieszczony w linku lub nawet URL umieszczony bezpośrednio w tekście będzie aktywny i klikalny.

Jeżeli chcesz, możesz samodzielnie dodać link: <a href="link">title</a>.

Wewnętrzne odnośniki

Możesz umieścić odnośnik do wewnętrznej podstrony, używając następującej składni: [[Delphi/Kompendium]] lub [[Delphi/Kompendium|kliknij, aby przejść do kompendium]]. Odnośniki mogą prowadzić do Forum 4programmers.net lub np. do Kompendium.

Wspomnienia użytkowników

By wspomnieć użytkownika forum, wpisz w formularzu znak @. Zobaczysz okienko samouzupełniające nazwy użytkowników. Samouzupełnienie dobierze odpowiedni format wspomnienia, zależnie od tego czy w nazwie użytkownika znajduje się spacja.

Znaczniki HTML

Dozwolone jest używanie niektórych znaczników HTML: <a>, <b>, <i>, <kbd>, <del>, <strong>, <dfn>, <pre>, <blockquote>, <hr/>, <sub>, <sup> oraz <img/>.

Skróty klawiszowe

Dodaj kombinację klawiszy komendą notacji klawiszy lub skrótem klawiszowym Alt+K.

Reprezentuj kombinacje klawiszowe używając taga <kbd>. Oddziel od siebie klawisze znakiem plus, np <kbd>Alt+Tab</kbd>.

Indeks górny oraz dolny

Przykład: wpisując H<sub>2</sub>O i m<sup>2</sup> otrzymasz: H2O i m2.

Składnia Tex

By precyzyjnie wyrazić działanie matematyczne, użyj składni Tex.

<tex>arcctg(x) = argtan(\frac{1}{x}) = arcsin(\frac{1}{\sqrt{1+x^2}})</tex>

Kod źródłowy

Krótkie fragmenty kodu

Wszelkie jednolinijkowe instrukcje języka programowania powinny być zawarte pomiędzy obróconymi apostrofami: `kod instrukcji` lub ``console.log(`string`);``.

Kod wielolinijkowy

Dodaj fragment kodu komendą . Fragmenty kodu zajmujące całą lub więcej linijek powinny być umieszczone w wielolinijkowym fragmencie kodu. Znaczniki ``` lub ~~~ umożliwiają kolorowanie różnych języków programowania. Możemy nadać nazwę języka programowania używając auto-uzupełnienia, kod został pokolorowany używając konkretnych ustawień kolorowania składni:

```javascript
document.write('Hello World');
```

Możesz zaznaczyć również już wklejony kod w edytorze, i użyć komendy  by zamienić go w kod. Użyj kombinacji Ctrl+`, by dodać fragment kodu bez oznaczników języka.

Tabelki

Dodaj przykładową tabelkę używając komendy . Przykładowa tabelka składa się z dwóch kolumn, nagłówka i jednego wiersza.

Wygeneruj tabelkę na podstawie szablonu. Oddziel komórki separatorem ; lub |, a następnie zaznacz szablonu.

nazwisko;dziedzina;odkrycie
Pitagoras;mathematics;Pythagorean Theorem
Albert Einstein;physics;General Relativity
Marie Curie, Pierre Curie;chemistry;Radium, Polonium

Użyj komendy by zamienić zaznaczony szablon na tabelkę Markdown.

Lista uporządkowana i nieuporządkowana

Możliwe jest tworzenie listy numerowanych oraz wypunktowanych. Wystarczy, że pierwszym znakiem linii będzie * lub - dla listy nieuporządkowanej oraz 1. dla listy uporządkowanej.

Użyj komendy by dodać listę uporządkowaną.

1. Lista numerowana
2. Lista numerowana

Użyj komendy by dodać listę nieuporządkowaną.

* Lista wypunktowana
* Lista wypunktowana
** Lista wypunktowana (drugi poziom)

Składnia Markdown

Edytor obsługuje składnię Markdown, która składa się ze znaków specjalnych. Dostępne komendy, jak formatowanie , dodanie tabelki lub fragmentu kodu są w pewnym sensie świadome otaczającej jej składni, i postarają się unikać uszkodzenia jej.

Dla przykładu, używając tylko dostępnych komend, nie możemy dodać formatowania pogrubienia do kodu wielolinijkowego, albo dodać listy do tabelki - mogłoby to doprowadzić do uszkodzenia składni.

W pewnych odosobnionych przypadkach brak nowej linii przed elementami markdown również mógłby uszkodzić składnie, dlatego edytor dodaje brakujące nowe linie. Dla przykładu, dodanie formatowania pochylenia zaraz po tabelce, mogłoby zostać błędne zinterpretowane, więc edytor doda oddzielającą nową linię pomiędzy tabelką, a pochyleniem.

Skróty klawiszowe

Skróty formatujące, kiedy w edytorze znajduje się pojedynczy kursor, wstawiają sformatowany tekst przykładowy. Jeśli w edytorze znajduje się zaznaczenie (słowo, linijka, paragraf), wtedy zaznaczenie zostaje sformatowane.

  • Ctrl+B - dodaj pogrubienie lub pogrub zaznaczenie
  • Ctrl+I - dodaj pochylenie lub pochyl zaznaczenie
  • Ctrl+U - dodaj podkreślenie lub podkreśl zaznaczenie
  • Ctrl+S - dodaj przekreślenie lub przekreśl zaznaczenie

Notacja Klawiszy

  • Alt+K - dodaj notację klawiszy

Fragment kodu bez oznacznika

  • Alt+C - dodaj pusty fragment kodu

Skróty operujące na kodzie i linijkach:

  • Alt+L - zaznaczenie całej linii
  • Alt+, Alt+ - przeniesienie linijki w której znajduje się kursor w górę/dół.
  • Tab/⌘+] - dodaj wcięcie (wcięcie w prawo)
  • Shit+Tab/⌘+[ - usunięcie wcięcia (wycięcie w lewo)

Dodawanie postów:

  • Ctrl+Enter - dodaj post
  • ⌘+Enter - dodaj post (MacOS)