Skip to content

Commit 6f7933f

Browse files
committed
Update docs
1 parent 5d618fc commit 6f7933f

File tree

4 files changed

+56
-6
lines changed

4 files changed

+56
-6
lines changed

docs/ch03-01-classes.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,14 @@ if __name__ == '__main__':
3030

3131
## `__init__()`
3232

33-
`__init__()` はインスタンス化するときに必ず呼び出される初期化関数です。引数には初期化に必要な値を渡すことができます。ただし第 1 引数は必ず `self` という引数にして下さい。`self` については後述します。
33+
`__init__()` はいわゆるコンストラクタです。コンストラクタには 2 つの役割があります。
34+
35+
1. インスタンス化をするときに最初に呼び出される
36+
1. クラスのメンバ変数を定義し、それを初期化する
37+
38+
クラスにどのようなメンバ変数を用意したいかということも含めてコンストラクタで定義することに注意して下さい。
39+
40+
引数には初期化に必要な値を渡すことができます。ただし第 1 引数は必ず `self` という引数にして下さい。`self` については後述します。
3441

3542
クラスで扱うメンバ変数を定義したいときは次のようにします。
3643

docs/ch04-02-packages.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,14 +57,17 @@ if __name__ == '__main__':
5757

5858
`パッケージ名.モジュール名.関数名` のように `.` で区切って関数にアクセスすることができます。ちなみにパッケージ内にパッケージが含まれていても問題ありません。
5959

60-
!!! warning "パッケージ名の命名規則"
61-
パッケージ名に `-` を使用するのは避けましょう。なぜなら `xxx-yyy` というパッケージを作ったとき
60+
!!! warning "モジュール・パッケージ名の命名規則"
61+
モジュール名・パッケージ名に `-` を使用するのは避けましょう。なぜなら `xxx-yyy` というモジュール・パッケージを作ったとき
6262

6363
```python
6464
import xxx-yyy
6565
```
6666

67-
のように import することになりますが `-` が引き算だと解釈されてしまいます。一般的にパッケージ名は次のルールを守るべきとされています
67+
のように import することになりますが `-` が引き算だと解釈されてしまいます。一般的に命名規則は次のようなるーるになっています
6868

69-
- 区切り文字は禁止(`-` 以外も)
7069
- 全て小文字
70+
- パッケージ名に区切り文字は禁止
71+
- モジュール名の区切り文字は `_` を使用
72+
73+
モジュール名であっても区切り文字はできるだけ使用しない方が好まれます。パッケージ名は例え複数語であっても区切り文字は使用しません。

docs/ch04-03-pip.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,41 @@
11
# pip
2+
3+
`pip` はインターネットで公開されている Python パッケージを取得するためのパッケージ管理ツールです。
4+
5+
## 使い方
6+
7+
[requests] という HTTP に関する機能を取り扱う有名なライブラリがあります。これを `pip` で取得して使ってみましょう。
8+
9+
[requests]: http://docs.python-requests.org/en/master/
10+
11+
ターミナル上で次のコマンドを実行して下さい。
12+
13+
```shell
14+
$ pip install requests
15+
```
16+
17+
!!! note
18+
Windows の場合は下記のコマンドを実行して下さい。
19+
20+
$ py -m pip install requests
21+
22+
成功したら次のようなソースコードを書いてみましょう。
23+
24+
```python
25+
#!/usr/bin/env python
26+
# -*- coding: utf-8 -*-
27+
28+
29+
import requests
30+
31+
32+
def main():
33+
response = requests.get('http://example.com')
34+
print(response.text)
35+
36+
37+
if __name__ == '__main__':
38+
main()
39+
```
40+
41+
実行すると http://example.com のページの HTML 文字列が出力されると思います。

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
このサイトは Python を学ぶ人向けのオンライン学習サイトです。
88

9-
## 誰向けのサイトか
9+
## 対象
1010

1111
- Python を初めて学ぶ人
1212
- プログラム言語を 1 つ以上経験したことのある人

0 commit comments

Comments
 (0)