From a8862dbb34f9396fb73e72ce7554a41ca36be214 Mon Sep 17 00:00:00 2001 From: Jeongseop Lim <86508420+jseop-lim@users.noreply.github.com> Date: Thu, 10 Aug 2023 16:36:22 +0900 Subject: [PATCH 1/3] =?UTF-8?q?ADD:=20=ED=83=80=EC=9E=85=ED=9E=8C=ED=8A=B8?= =?UTF-8?q?=20=EB=82=B4=EC=9A=A9=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Python/README.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/Python/README.md b/Python/README.md index 9816bdd..90d5cfb 100644 --- a/Python/README.md +++ b/Python/README.md @@ -1,6 +1,8 @@ Python ==== +## 코드 스타일 도구 + 기본적으로 [PEP8](https://www.python.org/dev/peps/pep-0008/)의 스타일을 따릅니다. 그리고 저희들은 일관된 스타일을 작성하는데 도움을 주는 다양한 도구들을 활용하고 있습니다. - [pre-commit](https://pre-commit.com/) - [black](https://black.readthedocs.io/en/stable/) @@ -25,6 +27,55 @@ max-line-length = 88 extend-ignore = E203 ``` +## Type Hinting +> [관련 논의](https://github.com/8percent/styleguide/discussions/47) + + +함수를 정의할 때는 매개변수와 반환형에 대한 타입 힌트를 답니다. 타입 힌트의 최대 활용 범위는 코드 작성자 재량에 맡깁니다. + +#### Do +```python +def greeting(name: str) -> str: + words = "Hello " + name + return words + + +def greeting(name: str) -> str: + words: str = "Hello " + name + return words +``` + +#### Don't do +```python +def greeting(name): + return "Hello " + name +``` + +인스턴스 메서드 첫 인자(self), 클래스 메서드 첫 인자(cls)에는 타입 힌트를 생략합니다. + +#### Do +```python +class Car: + def move(self, goal: str) -> str: + return "Move to " + goal + + def get_name(cls) -> str: + return "My Car" +``` + +return을 통해 값을 반환하지 않는 함수는 반환형 타입 힌트를 생략할 수 있습니다. + +#### Do +```python +def show_movie(name: str): + print("Hello " + name) + + +def show_movie(name: str) -> None: + print("Hello " + name) +``` + + ## 이외의 규칙 From a4aa12857104b516197d1953394f84fa8e3f2731 Mon Sep 17 00:00:00 2001 From: Jeongseop Lim <86508420+jseop-lim@users.noreply.github.com> Date: Fri, 11 Aug 2023 12:15:59 +0900 Subject: [PATCH 2/3] =?UTF-8?q?ADD:=20=EB=AC=B8=EC=9E=A5=20=EB=8B=A4?= =?UTF-8?q?=EB=93=AC=EA=B8=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Wook --- Python/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Python/README.md b/Python/README.md index 90d5cfb..6984b2e 100644 --- a/Python/README.md +++ b/Python/README.md @@ -31,7 +31,7 @@ extend-ignore = E203 > [관련 논의](https://github.com/8percent/styleguide/discussions/47) -함수를 정의할 때는 매개변수와 반환형에 대한 타입 힌트를 답니다. 타입 힌트의 최대 활용 범위는 코드 작성자 재량에 맡깁니다. +함수를 정의할 때는 매개변수와 반환형에 대한 타입 힌트도 추가합니다. 타입 힌트의 최대 활용 범위는 코드 작성자 재량에 맡깁니다. #### Do ```python From 08f2212edc876228cc179f35422bb9f6d6d69da5 Mon Sep 17 00:00:00 2001 From: Jeongseop Lim <86508420+jseop-lim@users.noreply.github.com> Date: Fri, 11 Aug 2023 12:17:46 +0900 Subject: [PATCH 3/3] =?UTF-8?q?CHG:=20=EB=AC=B8=EC=9E=A5=20=EA=B5=AC?= =?UTF-8?q?=EC=A1=B0=20=EB=B3=80=EA=B2=BD?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Python/README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/Python/README.md b/Python/README.md index 6984b2e..cad1f95 100644 --- a/Python/README.md +++ b/Python/README.md @@ -1,9 +1,10 @@ Python ==== -## 코드 스타일 도구 +기본적으로 [PEP8](https://www.python.org/dev/peps/pep-0008/)의 스타일을 따릅니다. -기본적으로 [PEP8](https://www.python.org/dev/peps/pep-0008/)의 스타일을 따릅니다. 그리고 저희들은 일관된 스타일을 작성하는데 도움을 주는 다양한 도구들을 활용하고 있습니다. +## 코드 스타일 도구 +일관된 스타일을 작성하는데 도움을 주는 다양한 도구들을 활용하고 있습니다. - [pre-commit](https://pre-commit.com/) - [black](https://black.readthedocs.io/en/stable/) - [isort](https://pycqa.github.io/isort/) @@ -28,9 +29,6 @@ extend-ignore = E203 ``` ## Type Hinting -> [관련 논의](https://github.com/8percent/styleguide/discussions/47) - - 함수를 정의할 때는 매개변수와 반환형에 대한 타입 힌트도 추가합니다. 타입 힌트의 최대 활용 범위는 코드 작성자 재량에 맡깁니다. #### Do