Alchemine Studio

Base Project Structure

 
  • May 06, 2023

Repository

https://github.com/alchemine/base-project —

base-project: Base Project Structure

Summary

1. Entrypoint

base_project/launch.py

git clone https://github.com/alchemine/base-project.git
cd base-project
python -m base_project.launch --dev

  1            | __main__.main()
  1.1          | main1()
  1.1.1        | main11()
* 1.1.1        | 0.00s (0.00m)
  1.1.2        | main12()
* 1.1.2        | 0.00s (0.00m)
* 1.1          | 0.00s (0.00m)
  1.2          | main2()
  1.2.1        | main21()
* 1.2.1        | 0.00s (0.00m)
* 1.2          | 0.00s (0.00m)
* 1            | 0.00s (0.00m)

2. common: Commonly used package

from base_project.common import *

3. configs.yaml: Configuration

1. Directory Structure

base-project
├── base_project
│   ├── common
│   │   ├── __init__.py
│   │   ├── env.py
│   │   ├── depth_logging.py
│   │   ├── timer.py
│   │   └── utils.py
│   ├── _utils.py
│   ├── configs.yaml
│   └── launch.py
├── docker-compose.yml
├── Dockerfile
├── README.md
└── .gitignore

2. common Package

2.1 Import

from base_project.common import *

See details in base_project/common/__init__.py.

2.2 Module Dependency

     env.py      : Environment module (library importing, option setting)
       ↓
    utils.py     : Utility module (function, class)
       ↓
    timer.py     : Timer module
       ↓
depth_logging.py : Depth logging module

2.3 Timer

  • Context manager
    • Timer(name) 
        from base_project.common.timer import Timer
      
  with Timer("Code1"):
      sleep(1)

        * Code1        | 1.00s (0.02m)
  • Decorator
    • @Timer(name)
    • @T 
      from base_project.common.timer import Timer, T
        
@Timer("fn1")
def fn1():
    sleep(1)
            
@T
def fn2():
    sleep(1)
      
fn1()
fn2()

      * fn1          | 1.00s (0.02m)
* Elapsed time | 1.00s (0.02m)

2.4 Depth Logging

  • Decorator: @D 
      from base_project.common.depth_logging import D
      
  @D
  def main(args):
      main1()
      main2()
  @D
  def main1():
      main11()
      main12()
  @D
  def main11():
      main111()
      main112()
  @D
  def main111():
      return
  @D
  def main112():
      return
  @D
  def main12():
      return
  @D
  def main2():
      main21()
  @D
  def main21():
      return
        
  main()

        1            | __main__.main()
    1.1          | main1()
    1.1.1        | main11()
    1.1.1.1      | main111()
  * 1.1.1.1      | 0.00s (0.00m)
    1.1.1.2      | main112()
  * 1.1.1.2      | 0.00s (0.00m)
  * 1.1.1        | 0.00s (0.00m)
    1.1.2        | main12()
  * 1.1.2        | 0.00s (0.00m)
  * 1.1          | 0.00s (0.00m)
    1.2          | main2()
    1.2.1        | main21()
  * 1.2.1        | 0.00s (0.00m)
  * 1.2          | 0.00s (0.00m)
  * 1            | 0.00s (0.00m)