publish: v1.1.0 - Refactors: More native (Rust)

- from wrapper to direct use of rust native module.
- Changed: `Calculator`, `DifficultyPoint`, `TimingPoint`, `Pos2`, `HitObjectKind`, `HitObject`.
- Refactor some functions.
- The rust logger is no longer included by default, unless the `rust_logger` feature is manually enabled for compilation.
- Smaller compiled `.pyd' or `.so'.

Author: Pure-Peace

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "peace-performance-python"
-version = "1.0.4"
+version = "1.1.0"
 authors = ["Pure-Peace <940857703@qq.com>"]
 edition = "2018"
 
@@ -44,13 +44,18 @@ async_std = [
     "pyo3-asyncio/async-std-runtime",
 ]
 
+# Irrelevant Features
+rust_logger = ["log", "timed", "pretty_env_logger"]
+
 
 [dependencies]
 pyo3 = { version = "0.14", features = ["extension-module"] }
-log = "0.4"
-timed = "0.2.1"
-pretty_env_logger = "0.4.0"
+paste = "1.0"
 
+# Rust logger optional
+log = { version = "0.4", optional = true }
+timed = { version = "0.2.1", optional = true }
+pretty_env_logger = { version = "0.4.0", optional = true }
 
 # Async optional
 pyo3-asyncio = { version = "0.14", optional = true }

README.md

@@ -60,10 +60,12 @@ from peace_performance_python.prelude import *
 
 from tests import async_run, join_beatmap, HITORIGOTO, UNFORGIVING
 
-
+# *No longer available by default (compile without `rust_logger` features enabled)*
 # Initialize Rust logger (optional)
+'''
 set_log_level('trace')
 init_logger()
+'''
 
 
 # Choose a style you like

beatmap_parse_examples.py

@@ -1,9 +1,13 @@
 from peace_performance_python.prelude import *
 from tests import join_beatmap, HITORIGOTO
 
+
+# *No longer available by default (compile without `rust_logger` features enabled)*
 # Initialize Rust logger (optional)
+'''
 set_log_level('trace')
 init_logger()
+'''
 
 
 def main():

examples.py

@@ -5,10 +5,12 @@
 
 from tests import async_run, join_beatmap, HITORIGOTO, UNFORGIVING
 
-
+# *No longer available by default (compile without `rust_logger` features enabled)*
 # Initialize Rust logger (optional)
+'''
 set_log_level('trace')
 init_logger()
+'''
 
 
 # Choose a style you like

peace_performance_python/__init__.py

@@ -7,8 +7,7 @@
 __author__ = 'Pure-Peace'
 __license__ = 'MIT'
 __copyright__ = 'Copyright 2021 Pure-Peace'
-__version__ = '1.0.1'
+__version__ = '1.1.0'
 
 from .objects import *
-from . import types
 from . import functions

peace_performance_python/_peace_performance/beatmap.pyi

@@ -1,11 +1,12 @@
 from pathlib import Path
-from . import BaseGetter
 from typing import Dict, List, Optional, Tuple
 
+from .types import BaseGetter
+
 
 class DifficultyPoint(BaseGetter):
     '''
-    DifficultyPoint object
+    DifficultyPoint object (`Rust`)
 
     `time`: `float`
 
@@ -23,7 +24,7 @@ class DifficultyPoint(BaseGetter):
 
 class TimingPoint(BaseGetter):
     '''
-    TimingPoint object
+    TimingPoint object (`Rust`)
 
     `time`: `float`
 
@@ -41,7 +42,7 @@ class TimingPoint(BaseGetter):
 
 class Pos2(BaseGetter):
     '''
-    Pos2 object
+    Pos2 object (`Rust`)
 
     `x`: `float`
 
@@ -81,7 +82,7 @@ class Pos2(BaseGetter):
 
 class HitObjectKind(BaseGetter):
     '''
-    HitObjectKind object
+    HitObjectKind object (`Rust`)
 
     `kind`: `str`
 
@@ -111,7 +112,7 @@ class HitObjectKind(BaseGetter):
 
 class HitObject(BaseGetter):
     '''
-    HitObject object
+    HitObject object (`Rust`)
 
     `start_time`: `float`
 
@@ -150,13 +151,13 @@ class HitObject(BaseGetter):
 
 class Beatmap(BaseGetter):
     '''
-    The Beatmap used to calculate the pp, it contains the parsed .osu beatmap.
+    The Beatmap (`Rust`) used to calculate the pp, it contains the parsed .osu beatmap.
 
     `path`: `Optional[Path]`
 
     `mode`: `int`
 
-    `mode_str`: `str`
+    `mode_str`: `Optional[str]`
 
     `version`: `int`
 
@@ -185,51 +186,9 @@ class Beatmap(BaseGetter):
     `timing_points`: `Optional[List[TimingPoint]]`
 
     `difficulty_points`: `Optional[List[DifficultyPoint]]`
-
-
-    # Examples:
-    ```
-    # Read and parse .osu files from local
-    beatmap = Beatmap('path_to_osu_file')
-    # Same as
-    beatmap = Beatmap.create('path_to_osu_file')
-
-    # Async Rust
-    beatmap = await Beatmap.create_async_rs('path_to_osu_file')
-    # Async Python (wrapper)
-    beatmap = await Beatmap.create_async_py('path_to_osu_file')
-
-
-
-    # We can reload this .osu files as:
-    beatmap.reload()
-
-    # Async Rust
-    await beatmap.reload_async_rs()
-    # Async Python (wrapper)
-    await beatmap.reload_async_py()
-
-    # We can load another .osu files as:
-    beatmap.init('path_to_another_osu_file')
-
-    # Async Rust
-    await beatmap.init_rs('path_to_another_osu_file')
-    # Async Python (wrapper)
-    await beatmap.init_py('path_to_another_osu_file')
-
-    # Calculate PP
-    c = Calculator()
-    c.set_acc(98.8)
-    c.set_combo(727)
-    # or
-    c = Calculator({'acc': 98.8, 'combo': 727})
-    # then
-    result = c.calculate(beatmap)
-
-    ```
     '''
     mode: int
-    mode_str: str
+    mode_str: Optional[str]
     version: int
 
     n_circles: int
@@ -244,6 +203,11 @@ class Beatmap(BaseGetter):
     tick_rate: float
     stack_leniency: Optional[float]
 
+    @property
+    def as_dict(self) -> Dict[str, float, str, None]: ...
+    @property
+    def attrs_dict(self) -> Dict[str, float, str, None]: ...
+
     @property
     def hit_objects(self) -> List[HitObject]: ...
     @property
@@ -252,5 +216,11 @@ class Beatmap(BaseGetter):
     def difficulty_points(self) -> List[DifficultyPoint]: ...
 
 
-async def read_beatmap_async(path: Path) -> Beatmap: ...
-def read_beatmap_sync(path: Path) -> Beatmap: ...
+async def read_beatmap_async(path: Path) -> Beatmap:
+    '''Read a beatmap async, returns Beatmap object (`Rust`)'''
+    ...
+
+
+def read_beatmap_sync(path: Path) -> Beatmap:
+    '''Read a beatmap, returns Beatmap object (`Rust`)'''
+    ...

peace_performance_python/_peace_performance/common.pyi

@@ -1,3 +1,51 @@
-def set_log_level(log_level: str) -> None: ...
-def init_logger() -> None: ...
-async def rust_sleep(secs: int) -> None: ...
+from typing import Optional
+
+
+from .types import (
+    OsuModeInt,
+    OsuModeStr,
+)
+
+
+def set_log_level(log_level: str) -> None:
+    '''
+    Sets the internal log level.
+
+    ### Available only when feature `rust_logger` is enabled. (Default disabled)
+
+    Levels: `['error', 'warning', 'info', 'debug', 'trace']`
+
+    trace levels log all internal timings.
+    '''
+    ...
+
+
+def init_logger() -> None:
+    '''
+    Initialises the logger for the rust lib, this can only be called once.
+
+    ### Available only when feature `rust_logger` is enabled. (Default disabled)
+
+    No logs will be displayed without calling this first however once called
+    the level can no-longer be adjusted.
+    '''
+    ...
+
+
+async def rust_sleep(secs: int) -> None:
+    '''
+    Async sleep (rust).
+
+    ### Available only when feature `async_tokio` / `async_std` is enabled. (Default enabled)
+    '''
+    ...
+
+
+def osu_mode_str(mode: OsuModeInt) -> Optional[OsuModeStr]:
+    '''Get osu! Mode str with mode int'''
+    ...
+
+
+def osu_mode_int(mode: OsuModeStr) -> Optional[OsuModeInt]:
+    '''Get osu! Mode int with mode str'''
+    ...