Improve methods order
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Refactoring
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- backend-api-design
Direzione di ricerca
Inizia facendo un inventario delle classi dell’SDK e dell’ordine attuale dei relativi metodi, quindi esamina i metodi dei test unitari per determinare se rispecchiano l’implementazione. Discuti il caso d’uso e il workflow previsti con i committers prima di modificare qualsiasi cosa. Il lavoro è completo quando i metodi dell’SDK seguono la convenzione di ordinamento in sei parti; i test unitari possono essere riordinati facoltativamente per corrispondere.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Description
The methods of a class should follow an ordering convention. Currently, all the methods are placed by either their usecase or just randomly in the class. The initial order was first mentioned in this comment, and after a discussion with @christoph-hamm, we decided this should be the final order:
- Class-level attributes
- Constructor (
__init__) - Alternative constructors (usually some class methods)
- Magic methods like
__str__,__len__,__del__etc. - Property methods
- The rest of the methods (public, private, static, class which are not ctor) (mixed together, following the "caller before the callee" rule)
The order should also be added to the DEVELOPMENT.md file, so that it's clear for future development of the SDK.
Goals
The code is refactored and the methods are in a proper order.
Final result
Summary
To be filled when the final solution is sketched.
Tasks
- Reorder the methods in the sdk
- Optional: Reorder the unit test methods to match the implementation
- Lingua principale
- Python
- Stelle
- 8
- Fork
- 4
- Merge medio
- 1g 2h
- PR unite (30g)
- 3
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di eclipse-ankaios/ank-sdk-python
-
Update Python support to 3.15Forse già presa @meheraz1100 l’ha presa 2 giorni fa. Apertapython-version
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
eclipse-ankaios/ank-sdk-python#158 · 1 commento · 1 assegnatario ·
-
python-version
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
-
enhancement good first issue
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
-
enhancement
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
eclipse-ankaios/ank-sdk-python#99 · 1 commento ·
-
Document the release processApertaenhancement
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
Tutte le issue di eclipse-ankaios/ank-sdk-python
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 62/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 70/100
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
topoteretes/cognee#5773 ·
I maintainer di solito rispondono entro 1 giorno
-
MiKTeX: a failed build reports no errors because texify --quiet switches the log to file:line: styleAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
SublimeText/LaTeXTools#1718 ·