README-dev.md

Panduan Pengembang

Panduan belum selesai

Install

1. Install python-poetry

2. Clone project

   git clone https://github.com/dapodix/dapodik.git

3. Install dependencies

   poetry install --no-root

4. Selesai.

Guideline

Import

1. Diusahakan immport berurutan, dan import \* diatas from \* import \*

   import abc
   import xyz
   from abc import de
   from efg import hi

2. Import internal harus dibawah import external dengan jarak 1 newline kosong.

Kontainer dataclass

Update

Jika data dapat diupdate maka pastikan sesuai dengan aturan berikut

from typing import Optional

import attr


@attr.dataclass
class Foo:
    bar: str = freeze(default=None) # Tidak akan dimasukan put request
    ban: str = None # Tidak akan dimasukan put request
    baz: Optional[str] = None # Akan dimmasukan ke dalam put request, meskipun null

Frozen

Data yang tidak dapat dirubah / hanya dapat diambil harus dibuat frozen, dan jika memungkinkan juga dibuat slots.

import attr


@attr.dataclass(frozen=True, slots=True)
class DataPermanen:
    a: str
    b: int