Merge pull request #44 from ArjanCodes/add_ruff_format_action

Add ruff format github action

.github/workflows/format.yaml

@@ -0,0 +1,27 @@
+name: Python Linting and formatting with Ruff
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+      - name: Install Ruff
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+      -  run: | 
+          ruff format
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: 'Code formatted with Ruff'

2022/ab_testing/with_tracking/feature.py

@@ -11,7 +11,6 @@ class Config:
 
 
 def read_config() -> Config:
-
     api_key = os.getenv("GROWTHBOOK_KEY") or ""
     response = requests.get(
         f"https://cdn.growthbook.io/api/features/{api_key}", timeout=5

2022/adapter/adapter/config_protocol.py

@@ -2,5 +2,4 @@
 
 
 class Config(Protocol):
-    def get(self, key: str) -> Any | None:
-        ...
+    def get(self, key: str) -> Any | None: ...

2022/adapter/adapter_partial/config_protocol.py

@@ -2,5 +2,4 @@
 
 
 class Config(Protocol):
-    def get(self, key: str, default: Any = None) -> Any | None:
-        ...
+    def get(self, key: str, default: Any = None) -> Any | None: ...

2022/adapter/adapter_partial/main.py

@@ -8,7 +8,6 @@
 
 
 def main() -> None:
-
     with open("config.json", encoding="utf8") as file:
         config = json.load(file)
     with open("config.xml", encoding="utf8") as file:

2022/async/after-1/iot/service.py

@@ -11,14 +11,11 @@ def generate_id(length: int = 8):
 
 
 class Device(Protocol):
-    async def connect(self) -> None:
-        ...
+    async def connect(self) -> None: ...
 
-    async def disconnect(self) -> None:
-        ...
+    async def disconnect(self) -> None: ...
 
-    async def send_message(self, message_type: MessageType, data: str = "") -> None:
-        ...
+    async def send_message(self, message_type: MessageType, data: str = "") -> None: ...
 
 
 class IOTService:

2022/async/after-2/iot/service.py

@@ -11,14 +11,11 @@ def generate_id(length: int = 8):
 
 
 class Device(Protocol):
-    async def connect(self) -> None:
-        ...
+    async def connect(self) -> None: ...
 
-    async def disconnect(self) -> None:
-        ...
+    async def disconnect(self) -> None: ...
 
-    async def send_message(self, message_type: MessageType, data: str = "") -> None:
-        ...
+    async def send_message(self, message_type: MessageType, data: str = "") -> None: ...
 
 
 class IOTService:

2022/async/before/iot/service.py

@@ -10,14 +10,11 @@ def generate_id(length: int = 8):
 
 
 class Device(Protocol):
-    def connect(self) -> None:
-        ...
+    def connect(self) -> None: ...
 
-    def disconnect(self) -> None:
-        ...
+    def disconnect(self) -> None: ...
 
-    def send_message(self, message_type: MessageType, data: str) -> None:
-        ...
+    def send_message(self, message_type: MessageType, data: str) -> None: ...
 
 
 class IOTService:

2022/asyncio_2/asyncio_gather.py

@@ -24,7 +24,6 @@ async def get_random_pokemon_name() -> str:
 
 
 async def main() -> None:
-
     # synchronous call
     time_before = perf_counter()
     for _ in range(20):

2022/asyncio_2/asyncio_iter.py

@@ -22,7 +22,6 @@ async def next_pokemon(total: int) -> AsyncIterable[str]:
 
 
 async def main():
-
     # retrieve the next 10 pokemon names
     async for name in next_pokemon(10):
         print(name)

2022/asyncio_2/sync_to_async_before.py

@@ -21,7 +21,6 @@ def send_request(url: str) -> int:
 
 
 async def main() -> None:
-
     status_code = send_request("https://www.arjancodes.com")
     print(f"Got HTTP response with status {status_code}")
 

2022/asyncio_2/sync_to_async_correct.py

@@ -25,7 +25,6 @@ async def send_async_request(url: str) -> int:
 
 
 async def main() -> None:
-
     status_code, _ = await asyncio.gather(
         send_async_request("https://www.arjancodes.com"), counter()
     )

2022/bridge_pattern/with_abc/stream/service.py

@@ -6,7 +6,6 @@
 
 @dataclass
 class StreamingService(ABC):
-
     devices: list[Buffer] = field(default_factory=list)
 
     def add_device(self, device: Buffer) -> None:

2022/bridge_pattern/with_function/stream/service.py

@@ -2,11 +2,8 @@
 
 
 class StreamingService(Protocol):
-    def start_stream(self) -> str:
-        ...
+    def start_stream(self) -> str: ...
 
-    def fill_buffer(self, stream_reference: str) -> None:
-        ...
+    def fill_buffer(self, stream_reference: str) -> None: ...
 
-    def stop_stream(self, stream_reference: str) -> None:
-        ...
+    def stop_stream(self, stream_reference: str) -> None: ...

2022/bridge_pattern/with_function/stream/twitch_stream.py

@@ -6,7 +6,6 @@
 
 @dataclass
 class TwitchStreamingService:
-
     buffer: Buffer
 
     def start_stream(self) -> str:

2022/bridge_pattern/with_function/stream/youtube_stream.py

@@ -6,7 +6,6 @@
 
 @dataclass
 class YouTubeStreamingService:
-
     buffer: Buffer
 
     def start_stream(self) -> str:

2022/bridge_pattern/with_protocol/stream/device.py

@@ -4,5 +4,4 @@
 
 
 class StreamingDevice(Protocol):
-    def get_buffer_data(self) -> BufferData:
-        ...
+    def get_buffer_data(self) -> BufferData: ...

2022/bridge_pattern/with_protocol/stream/service.py

@@ -2,11 +2,8 @@
 
 
 class StreamingService(Protocol):
-    def start_stream(self) -> str:
-        ...
+    def start_stream(self) -> str: ...
 
-    def fill_buffer(self, stream_reference: str) -> None:
-        ...
+    def fill_buffer(self, stream_reference: str) -> None: ...
 
-    def stop_stream(self, stream_reference: str) -> None:
-        ...
+    def stop_stream(self, stream_reference: str) -> None: ...

2022/bridge_pattern/with_protocol/stream/twitch_stream.py

@@ -7,7 +7,6 @@
 
 @dataclass
 class TwitchStreamingService:
-
     device: StreamingDevice
 
     def start_stream(self) -> str:

2022/bridge_pattern/with_protocol/stream/youtube_stream.py

@@ -7,7 +7,6 @@
 
 @dataclass
 class YouTubeStreamingService:
-
     device: StreamingDevice
 
     def start_stream(self) -> str:

2022/cicd/functions/routes.py

@@ -5,6 +5,7 @@
 # Define an internal Flask app
 app = Flask("internal")
 
+
 # Define the internal paths, idiomatic Flask definition
 @app.route("/channels/<string:channel_id>", methods=["GET", "POST"])
 def channel(channel_id: str):

2022/code_roast/after/main.py

@@ -7,7 +7,6 @@
 
 
 def main() -> None:
-
     # read the configuration settings from a JSON file
     config = read_config("./config.json")
 

2022/code_roast/after/scrape/fetch.py

@@ -34,7 +34,6 @@ def fetch_terms_from_pubid(target: pd.DataFrame, scraper: Scraper) -> pd.DataFra
 
 
 def fetch_terms_from_pdf_files(config: ScrapeConfig) -> pd.DataFrame:
-
     search_terms = [
         path.join(config.paper_folder, file)
         for file in listdir(config.paper_folder)

2022/code_roast/after/scrape/scraper.py

@@ -11,5 +11,4 @@ class ScrapeResult:
 
 
 class Scraper(Protocol):
-    def scrape(self, search_text: str) -> ScrapeResult:
-        ...
+    def scrape(self, search_text: str) -> ScrapeResult: ...

2022/code_roast_battleship/after.py

@@ -94,7 +94,6 @@ def play_game(player_count: int, board: BattleshipBoard) -> None:
     won_game = False
 
     while total_guesses < GUESSES_COUNT * player_count:
-
         # determine the current player and the remaining guesses
         current_player = (total_guesses % player_count) + 1
         remaining_guesses = GUESSES_COUNT - total_guesses // player_count

2022/code_roast_rpsls/before/entity.py

@@ -9,4 +9,4 @@ class Entity(Enum):
     LIZARD = auto()
 
     def __repr__(self) -> str:
-        return f"{self.name} : {self.value}"
+        return f"{self.name} : {self.value}"