Python - podstawowa praca z projektem

Python - podstawowa praca z projektem
NS
  • Rejestracja:ponad 7 lat
  • Ostatnio:7 dni
  • Postów:455
0

Hej,
nauczyłem się ostatnimi czasy Pythona i trochę jestem zdezorientowany.

Wcześniej pracowałem np. z Maven/Gradle czy angular-cli (npm) i o ile tam było wszystko proste to w Pythonie nie wiem jak zachowując dobre praktywki, rozwijać projekt.

Utworzyłem katalog i w nim powołałem do życia środowisko wirtualne za pomocą:

Kopiuj
$virtualenv my_project

Pokazały mi się katalogi /bin /inclue /lib.
I pytanie: gdzie umieszcza się kod źródłowy pisany przeze mnie?
Gdzie umieszcza się resources (takie pliki jak w Javie, jakieś yamle, propertiesy etc.)?
Gdzie umieszcza się katalog z testami?

--/my_project/
------/my_virtualenv/
----------/bin
----------/include
----------/lib

I jeszcze kilka pytań:
Jak miałem gotowy kod źródłowy to mogłem sobie spakować gotowego builda np.

Kopiuj
$.gradlew build
$ng build
$mvn install

A tu w Pythonie mamy taki zestaw komend do pakowania, czyszczenia, podawania opcji uruchomienia interpreterowi etc?

Prośba o informacje, albo może jakiś link opisujący to.

lion137
  • Rejestracja:około 8 lat
  • Ostatnio:4 minuty
  • Postów:4893
1

Stworzyłeś środowisko wirtualne z oddzielnym interpreterem do projektu, jak go Aktywujesz (source /my_project/bin/activate), to to będzie domyślny interpreter; Możesz go też dodać w edytorze. Kod czy testy, Dajesz gdzie Chcesz. Więcej:
Pakiety w Pythonie Dawno nie...
https://python-guide.readthedocs.io/en/latest/dev/virtualenvs/
https://python-packaging.readthedocs.io/en/latest/
https://medium.com/small-things-about-python/lets-talk-about-python-packaging-6d84b81f1bb5#.b9ww4h4xt


Spearhead
  • Rejestracja:prawie 6 lat
  • Ostatnio:około 6 godzin
  • Postów:1002
1

Katalogu z virtualenvem nie wkładasz do gita, możesz go wstawiać do .gitignore. Zawiera on binarki, biblioteki i interpreter. Istnieje również takie coś jak virtualenvwrapper, który ułatwia zarządzanie wirtualnymi ścieżkami, trzymając je w wybranej lokalizacji (np. ~/.virtualenvs, zobacz tutorial), żeby mieć porządek w katalogu z projektem. W katalogu projektem tworzysz sobie plik requirements.txt, w którym wypisujesz zależności, opcjonalnie razem z wersjami. Jak ktoś będzie chciał uruchomić twój projekt, to sobie zainstaluje.

W katalogu z projektem leży też plik setup.py, który pozwala na instalację twojego softu, oraz konfigi do różnych narzędzi, takich jak tox. Kod źródłowy można wrzucić w katalogu o tej samej nazwie co sam projekt (albo src/nazwa_projektu), obok leżą pliki z testami oraz dokumentacja (z reguły projekt Sphinx). Wychodzi z tego coś takiego:

Kopiuj
$ tree mylib/
mylib/
├── docs
├── mylib
│   ├── __init__.py
│   ├── some_class.py
│   └── some_utils.py
├── README.md
├── setup.py
├── tests
└── tox.ini

virtulenv może sobie siedzieć gdziekolwiek, bylebyś go miał jak aktywować. Więcej dyskusji tutaj.

Generalnie ponieważ układanie tego wszystkiego to ból tyłka, polecam projekt pyscaffold, który generuje ci gotowy do wypełnienia szablon do projektów.

Kopiuj
$ putup test_project
$ tree test_project/
test_project/
├── AUTHORS.rst
├── CHANGELOG.rst
├── docs
│   ├── authors.rst
│   ├── changelog.rst
│   ├── conf.py
│   ├── index.rst
│   ├── license.rst
│   ├── Makefile
│   └── _static
├── LICENSE.txt
├── README.rst
├── requirements.txt
├── setup.cfg
├── setup.py
├── src
│   └── test_project
│       ├── __init__.py
│       └── skeleton.py
└── tests
    ├── conftest.py
    └── test_skeleton.py

5 directories, 17 files

Analiza wygnerowanego szablonu będzie pouczająca. virtualenv tworzysz sobie własny, gdzie ci wygodnie. Co do bundlowania - od tego mamy setup.py. PyScaffold powyżej już nam takiego wygenerował. Żeby zainstalować ten projekt w danym środowisku, wchodzimy do niego i odpalamy:

Kopiuj
$ cd test_project
$ python setup.py install

Możemy teraz uruchomić liba:

Kopiuj
Python 3.7.3 (default, Aug 20 2019, 17:04:43) 
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from test_project.skeleton import fib
>>> fib(10)
55
>>> 

Testy możesz sobie odpalić

Kopiuj
$ python setup.py test

Dokumentacje budujesz tak:

Kopiuj
$ cd docs
$ make html

Będą leżeć w ./build/sphinx/html (trzeba mieć Sphinxa - pip install sphinx).

edytowany 4x, ostatnio: Spearhead
NS
  • Rejestracja:ponad 7 lat
  • Ostatnio:7 dni
  • Postów:455
0

@Spearhead: dzięki za bardzo wyczerpujący post.

Jeszcze tylko jedno: jak ukończę pisanie kodu to muszę go jakoś budować jak w innych technologiach?
Czy po prostu wystarczy sklonować repo i uruchomić jakiś punkt wejściowy skryptu?

Bo w językach kompilowanych np. Java, miałem zbudowany plik .jar i wrzucałem go na serwer i super. A jak wygląda deployment aplikacji webowej Pythonowej np. w Django.

O co mi tak naprawdę chodzi. Piszę aplikację automatyzującą niektóre kroki dla testerów manualnych i chcę, aby testerzy mogli ją szybko sobie odpalić jedną komendą, żeby nie komplikować.

Istnieje coś jak

Kopiuj
$ virtualenv run

?

Spearhead
  • Rejestracja:prawie 6 lat
  • Ostatnio:około 6 godzin
  • Postów:1002
1

@NeutrinoSpinZero, zwróć uwagę, że w pliku setup.cfg masz sekcję:

Kopiuj
[options.entry_points]
# Add here console scripts like:
# console_scripts =
#     script_name = test_project.module:function
# For example:
# console_scripts =
#     fibonacci = test_project.skeleton:run
# And any other entry points, for example:
# pyscaffold.cli =
#     awesome = pyscaffoldext.awesome.extension:AwesomeExtension

Odkomentując sobie te linie:

Kopiuj
console_scripts =
    fibonacci = test_project.skeleton:run

I instalując pakiet uzyskujesz program:

Kopiuj
$ fibonacci 
usage: fibonacci [-h] [--version] [-v] [-vv] INT
fibonacci: error: the following arguments are required: INT
$ fibonacci 21
The 21-th Fibonacci number is 10946

Żeby zaś dostarczyć ten pakiet można na pryzkład zainstalować sobie własny serwer pakietów z użyciem devpi i instalować:

Kopiuj
$ pip install --extra-index-url ścieżka-do-serwera sample_project

Inny sposób to pliki wheel, odpowiednik Javowych jar-ów. Najpierw instalujesz wheel:

Kopiuj
$ pip install wheel

I w katalogu projektu:

Kopiuj
$ python setup.py bdist_wheel

Zbudowany plik z rozszerzeniem whl będzie leżał w katalogu dist. Możesz go zuploadować na jakiś serwer i też isntalować pip install:

Kopiuj
$ pip install ./dist/test_project-0.0.post0.dev1+g1a22b06.dirty-py2.py3-none-any.whl
Processing ./dist/test_project-0.0.post0.dev1+g1a22b06.dirty-py2.py3-none-any.whl
Installing collected packages: test-project
Successfully installed test-project-0.0.post0.dev1+g1a22b06.dirty
$ fibonacci
usage: fibonacci [-h] [--version] [-v] [-vv] INT
fibonacci: error: the following arguments are required: INT
$ fibonacci 12
The 12-th Fibonacci number is 144

Jeszcze inny sposób do zbudowanie pakietu deb.

Jak to nie *nix a Windowsy, to istnieją konwertery do exe, jakieś py2exe i podobne - tego akurat nigdy nie używałem.

Deployment web apek to trochę szerszy temat. Słowo klucz to uWSGI, Stawia się jakiś serwer jak Gunicorn za Nginixem i tym podobne. Tu się też za wiele nie bawiłem, od tego byli devopsi, ja tylko rozwijałem aplikacje.

NS
@Spearhead: dziękuję po raz kolejny.
AH
  • Rejestracja:około 6 lat
  • Ostatnio:dzień
  • Postów:13
0

Hmm, a czy w tym co generuje pyscaffold nie brakuje pyproject.toml zgodnie z PEP518?

edytowany 1x, ostatnio: AntonioHa
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)