Pierwszy projekt w Python' ie. Jakieś uwagi odnośnie kodu?

Pierwszy projekt w Python' ie. Jakieś uwagi odnośnie kodu?
supremeje
SU
supremeje
SU
  • Rejestracja:około 6 lat
  • Ostatnio:prawie 5 lat
  • Postów:91
0

Witam,
Znam już podstawy Pythona i postanowiłem, że napiszę pierwszy, prosty projekt (Szyfr cezara). Prosiłbym o opinie nad czym muszę popracować/co zmienić/czy kod jest przejrzysty itp. (Tak wiem, że jeśli na starcie wpiszę np. słowo "wyraz" i klucz "20", to program w pewnym sensie się wysypie z powodu ost. litery "z", ale nie zwracajcie na to uwagi. W pełni działający skrypt mam na kompie, a aktualnie nie mam do niego dostępu. Ale różni się tylko warunkiem if WprowadzonyTekst >= maks ascii od z)

Kopiuj
#Funkcja szyfrowania
def szyfruj(WprowadzTekst, klucz):  
    for i in range(len(WprowadzTekst)):
        if(ord(szyfr[i]) == 32):
            szyfr[i] = " "
        else:
            szyfr[i] = chr(ord(szyfr[i]) + klucz)

#Funkcja deszyfrowania
def deszyfruj(szyfr, klucz):
    for i in range(len(szyfr)):
        if(ord(szyfr[i]) == 32):
            szyfr[i] = " "
        else:
            szyfr[i] = chr(ord(szyfr[i]) - klucz)

#Połącz znaki z listy w jeden wyraz
def listToString(szyfr):  
    str1 = ''   
    return (str1.join(szyfr))

#Wprowadz tekst, który chcesz zaszyfrować
WprowadzTekst = input("Wprowadz tekst: ")

#Utwórz listę (Znaków w string'u nie da się zamienić)
szyfr = list(WprowadzTekst)

#Wprowadz klucz
klucz = int(input("Wprowadz klucz: "))

#Wywołaj funkcję szyfruj i wyświetl zaszyfrowany tekst
szyfruj(WprowadzTekst, klucz)
print(listToString(szyfr))

#Wywołaj funkcję deszyfruj i wyświetl odszyfrowany tekst
deszyfruj(szyfr, klucz)
print(listToString(szyfr))
LukeJL
możesz dodać kolorowanie składni (```python na początku bloku). będzie sie latwiej czytać
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
UglyMan
UglyMan
UglyMan
UglyMan
  • Rejestracja:około 6 lat
  • Ostatnio:około 3 lata
  • Postów:2206
1

Jak działa to jest ok,. Z takich uwag ogólnych to używaj nazw anglojęzycznych. Ni musisz komentować każdej linijki kodu. Im mniej komentarzy tym lepiej. Zadko kometarze żyją razem z kodem i potem tylko wprowadzają w błąd.

Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
Althorion
Althorion
Althorion
Althorion
Moderator C/C++
  • Rejestracja:prawie 10 lat
  • Ostatnio:około 18 godzin
  • Postów:1603
0

To samo co wyżej, a ponadto:

  1. Twój program głośno się wysypie, jak dostanie pusty szyfr lub klucz.
  2. Twoje funkcje polegają w niejawny sposób na zewnętrznym stanie w postaci tablicy szyfr.
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
semicolon
semicolon
semicolon
semicolon
  • Rejestracja:ponad 5 lat
  • Ostatnio:prawie 5 lat
  • Postów:114
1

Funkcja szyfruj modyfikuje globalną to źle
Funkcja deszyfruj modyfikuje lokalny argument szyfr co w tym przypadku jest zbędne
Lepiej byłoby, gdyby żadna z tych funkcji nie modyfikowała, a tworzyła nowy wynik na podstawie argumetnów. W pythonie takie podejście dużo bardziej się zwraca.

Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
lion137
lion137
lion137
lion137
  • Rejestracja:około 8 lat
  • Ostatnio:5 minut
  • Postów:4886
1

W Pythonie stosuje się "camel case" tylko do nazw klas (zaczynają się od dużej litery), a w funkcjach rozdzielamy wyrazy podkreśleniem ("underscore"). Czyli:
list_to_string, a nie listToString, ale:
ClassCipher, nie Class_cipher.

edytowany 1x, ostatnio: lion137
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
jvoytech
JV
jvoytech
JV
  • Rejestracja:ponad 6 lat
  • Ostatnio:około 2 miesiące
  • Postów:242
1

Jak już masz pisać tego typu komentarze:

Kopiuj
# cos tam cos tam
def funkcja():
    pass

lepiej napisz docstring-a, np:

Kopiuj
def funkcja(par1):
    """
    funkcja robi to i to

    Parameters
    ----------------
    par1: int
        bla bla bla

    Returns
    ---------
    out: list
        list of ints...

    Examples
    -------------
    >>> funkcja(3)
    [1,2,3]
    """
    return list(range(par1))

Z tego można wygenerować automatycznie dokumentację do HTML. IDE powinno sobie poradzić z docstringiem i podpowiadać programiście co dana funkcja robi. W REPLu po imporcie wystarczy napisać help(funkcja)<ENTER> a w ipython funkcja?<ENTER> żeby wyświetlić dokumentacje do funkcji.

Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
anonimowy
AN
anonimowy
AN
  • Rejestracja:prawie 11 lat
  • Ostatnio:około 16 godzin
  • Postów:973
0
Kopiuj
def listToString(szyfr):  
    str1 = ''   
    return (str1.join(szyfr))

Ta funkcja jest zbędna. Robi się to po prostu tak ''.join.(szyfr) jest to powszechne i normalne zastosowanie. Na dobrą sprawę Twoja funkcja to tylko zmiana nazwy

Zdalna praca dla Senior Python Developerów --> PW
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
enedil
enedil
enedil
enedil
  • Rejestracja:ponad 11 lat
  • Ostatnio:około 13 godzin
  • Postów:1027
0
Kopiuj
        if(ord(szyfr[i]) == 32):
            szyfr[i] = " "
        else:
            szyfr[i] = chr(ord(szyfr[i]) + klucz)

Dlaczego ord(szyfr[i]) == 32, a nie szyfr[i] == ' '? Poza tym, gdybyś unikał zmiennych globalnych (tak jak to było wspomniane wyżej), to mógłbyś zrobić

Kopiuj
szyfr = [" " if znak == " " else chr(ord(znak) + klucz) for znak in szyfr]
edytowany 1x, ostatnio: enedil
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
Treść
Podgląd
Kliknij, aby dodać treść...
Kliknij, aby dodać załącznik lub wklej ze schowka.
Instrukcja obsługi Markdown
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)