2024-03-19

【Git】Git ～ git remote prune ～

Git Github

■ はじめに

小ネタ。

git pullした際に、エラー「error: some local refs could not be updated」が発生して
その際に「git remote prune origin」を実行して解決した(詳細は【０】参照)
そもそも、これなんだって思ったので、メモ。

【０】トラブル：git pullした際に、エラーが発生

１）エラー内容

error: some local refs could not be updated; try running
 'git remote prune origin' to remove any old, conflicting branches

２）解決案

原因が後々で、、、
「git remote prune origin」を実行する
 => で、これって何？って思って調べてみた

【１】git remote prune

* ローカルリポジトリからリモートに存在しないブランチを削除する

cf. prune (プルーン)
 = 切り取る, 刈り取る,
　〔不要なもの・余分なものを〕取り除く, 削る
　〔費用を〕切り詰める

【２】使用用途 (【０】の原因)

ローカルリポジトリとリモートリポジトリで同期が取れておらず
ローカルリポジトリには存在するが、
リモートリポジトリに存在しないブランチを削除する場合

Git ～入門編～
https://dk521123.hatenablog.com/entry/2018/06/29/104028
Git ～基本編 / あれこれ～
https://dk521123.hatenablog.com/entry/2018/07/01/005431

2024-03-19

【Python】パッケージ配布～ setup.pyによる作成方法～

Python

■ はじめに

https://dk521123.hatenablog.com/entry/2020/02/09/234350

で egg / wheel ファイルを作成したが、
今回は、Pythonのパッケージ配布で、ちょっと古い方法だが
setup.pyによる作成方法について扱う

ちなみに、この手の話は、結構、古いやり方とかあるので
ちょっと混乱する。

別の方法は、以下の関連記事を参照のこと

パッケージ配布～ pyproject.tomlによる作成方法～
https://dk521123.hatenablog.com/entry/2024/03/28/000000

【１】用語整理
　１）setuptools
　２）setup.py
【２】setup.pyを使った作成方法
　１）ファイル構成
　２）コマンドによるパッケージ作成
【３】使い方
　１）インストール方法１：ファイルから pip install
　２）インストール方法２：GitHubから pip install
　３）アンインストール
【４】補足１：__init__.py の役割
　１）「[2] インポートの制御のため」について
　２）解決策「__all__」

【１】用語整理

１）setuptools

* Pythonパッケージするためのツール
 => 作成したモジュールを pip install でインストール可能になる

https://packaging.python.org/ja/latest/guides/distributing-packages-using-setuptools/
https://packaging.python.org/ja/latest/key_projects/#setuptools

２）setup.py

* パッケージのメタデータを定義

https://packaging.python.org/ja/latest/discussions/setup-py-deprecated/

より抜粋
~~~~
setup.py は非推奨になりましたか？
いいえ、 setup.py および Setuptools は非推奨にはなっていません。
・・・略・・・
しかしながら、 python setup.py および setup.py を
コマンドラインツールとして使うことは非推奨になりました。
・・・略・・・
python setup.py install
python setup.py develop
python setup.py sdist
python setup.py bdist_wheel

sdist

* ソースコードをtar.gz形式で配布

bdist_wheel

* ビルド済みのファイルをwheel形式で配布
 => 以下の関連記事でも使用した

https://dk521123.hatenablog.com/entry/2020/02/09/234350

【２】setup.pyを使った作成方法

* 以下の「１）ファイル構成」で行う

１）ファイル構成

├─ hello_package # パッケージ
│   ├─ world_sub_package # サブパッケージ（Options）
│   │   ├─ __init__.py # ★今回は空ファイルでもいい。詳細は「補足１：__init__.py の役割」を参照
│   │   └─ world.py # サブモジュール
│   ├─ __init__.py # ★今回は空ファイルでもいい。詳細は「補足１：__init__.py の役割」を参照
│   └─ hello.py # モジュール
├─ main.py # モジュール動作確認用プログラム（Options）
└─ setup.py # プロジェクトの一番上(ルート)にある必要がある

setup.py

from setuptools import setup

setup(
  # Package name
  name="hello_package",
  # Package version
  version="1.0.0",
  packages=[
    "hello_package",
    "hello_package.world_sub_package"
  ],
  url="https://dk521123.hatenablog.com/",
  license="MIT",
  author="Your-name",
  author_email="your-email@xxx.com",
  description="This is just a sample"
)

hello_package.hello.py

def say_hello(name):
  return f"Hello, {name}!!"

hello_package.world_sub_package.world.py

def say_world():
  return "The World!!?"

main.py

import hello_package.hello
from hello_package.world_sub_package import world

result1 = hello_package.hello.say_hello("Mike")
# The result from hello - Hello, {name}!!
print(f"The result from hello - {result1}")

result2 = world.say_world()
# The result from world - The World!!?
print(f"The result from world - {result2}")

２）コマンドによるパッケージ作成

https://packaging.python.org/ja/latest/guides/distributing-packages-using-setuptools/#packaging-your-project

に従って行うと、以下の成果物（パッケージ配布物）ができる
~~~~~
* dist/hello_package-1.0.0.tar.gz
* dist/hello_package-1.0.0-py3-none-any.whl
~~~~~

コマンド例

# Step1: build パッケージをインストールする
python -m pip install build

# Step2: パッケージ作成
python -m build

# 個別で作成したい場合
# python -m build --sdist
# python -m build --wheel

# 以下は、もう古いらしい。。。
# python setup.py sdist
# python setup.py bdist_wheel

【３】使い方

１）インストール方法１：ファイルから pip install

# インストール
pip install dist/hello_package-1.0.0.tar.gz
# pip install dist/hello_package-1.0.0-py3-none-any.whl

・・・略・・・
Successfully built hello-package
Successfully installed hello-package-1.0.0
・・・略・・・

# 確認
pip list
・・・略・・・
hello_package                 1.0.0
・・・略・・・

２）インストール方法２：GitHubから pip install

* 「pip install git+＜GithubRepositoryURL＞」でインストール可能

コマンド例

# リポジトリ名とパッケージ名が同じ場合
pip install git+https://github.com/acc_name/pkg_name.git

# リポジトリ名とパッケージ名が異なる場合
#  =>「パッケージ名@」を「git+https://…….git」の前に付加
pip install pkg_name@git+https://github.com/acc_name/repo_name.git

# 「@v1.0」のように末尾にバージョンやタグを付加することも可能
pip install git+https://github.com/acc_name/pkg_name.git@v1.0

３）アンインストール

pip uninstall --yes hello_package

【４】補足１：init.py の役割

* __init__.py の主な役割は、以下の通り。

[1] Pythonパッケージとして認識させるため
[2] インポートの制御のため
[3] パッケージの初期化 / パッケージ全体の設定

 => 詳細は、以下のサイトを参照。

https://ya6mablog.com/how-to-use-init-py/

１）「[2] インポートの制御のため」について

例えば、以下のように変更すると、エラーになる
* 同じパッケージ内にファイルを追加
* main.pyの import を「*」に変更

エラーになるフォルダ構成

hello_package.world_sub_package
 + world.py
 + world2.py << 追加し、同じメソッドを追加
main.py << 変更（『[エラー] main.py』を参照）

[エラー] main.py

import hello_package.hello
# 「*」に変更するとエラーになる
#from hello_package.world_sub_package import world
from hello_package.world_sub_package import *

result1 = hello_package.hello.say_hello("Mike")
print(f"The result from hello {result1}")

result2 = world.say_world()
print(f"The result from world {result2}")

２）解決策「all」

* 以下のように

hello_package.world_sub_package.init.py

__all__ = ['hello', 'hello2']

参考文献

bdist/sdist
https://blog.n-t.jp/post/tech/python-wheel-bdist-sdist-pip/
setup.py
https://ya6mablog.com/how-to-use-setup-py/

パッケージ配布～ setuptoolsあれこれ～
https://dk521123.hatenablog.com/entry/2024/04/17/132415
パッケージ配布～ pyproject.tomlによる作成方法～
https://dk521123.hatenablog.com/entry/2024/03/28/000000
egg / wheel ファイルを作成する
https://dk521123.hatenablog.com/entry/2020/02/09/234350
パッケージ管理～ pip ～
https://dk521123.hatenablog.com/entry/2021/07/02/000000
オフライン環境下で pip install するには
https://dk521123.hatenablog.com/entry/2021/07/10/164833

2024-03-16

【k8s】Kubernetes ～基本編 / Pod ～

Kubernetes

■ はじめに

Kubernetes の Pod（ポッド）についてまとめる。

【１】Pod
【２】Pod作成方法
　１）YAML を使ってPod作成
　２）kubectl run を使ってPod作成
【３】Pod確認方法
　１）kubectl get pod
　２）kubectl get pod <PodName>
【４】Pod削除方法
　１）YAML で作ったPodの削除
　２）kubectl run で作ったPodの削除

【１】Pod

* 1つ以上のコンテナから構成された最小単位

【２】Pod作成方法

１）YAML を使ってPod作成

[1] YAMLファイルを作る

# demo_pod.yml

# [1] どのKubenetics APIバージョンを用いるか
apiVersion: v1

# [2] どの Kubenetics オブジェクトを指定するか（e.g. Pod/Development）
# Pod指定
kind: Pod

# [3] Kubenetics オブジェクトを一意に特定するための情報を付与
# e.g. name/UID/namespace
metadata:
  # ★ここが、名前になる
  name: demo-nginx

# [4] 理想状態（desired state）を指定
spec:
  containers:
    - image: nginx
      name: nginx

[2] kubectl createコマンドで起動する

# kubectl create -f <[1]で作ったYAML>
$ kubectl create -f demo_pod.yml
pod/demo-nginx created

# 作成したPodを確認する
$ kubectl get pod
NAME                     READY   STATUS    RESTARTS       AGE
demo-nginx               1/1     Running   0              22s

# クラスター内で利用できるすべてのリソースの完全なリストを表示
#  =>「apiVersion: v1」が確認できる
$ kubectl api-resources | grep pod
pods                              po           v1                                     true         Pod
...

２）kubectl run を使ってPod作成

# Helpに載っている
$ kubectl run -h
Create and run a particular image in a pod.

Examples:
  # Start a nginx pod
  kubectl run nginx --image=nginx
...

# ★実行してみる
# kubectl run <PodName> --image=nginx
$ kubectl run nginx-by-command --image=nginx
pod/nginx-by-command created

# 確認
$  kubectl get pod
NAME                     READY   STATUS    RESTARTS      AGE
demo-nginx               1/1     Running   1 (38m ago)   12h
nginx-by-command         1/1     Running   0             15s

【３】Pod確認方法

１）kubectl get pod

# Pod一覧表示
$ kubectl get pod

２）kubectl get pod

# kubectl get pod <PodName>
$  kubectl get pod demo-nginx
NAME         READY   STATUS    RESTARTS      AGE
demo-nginx   1/1     Running   1 (53m ago)   12h

# Spec情報表示（YAMLファイルの「spec:｣を参照）
$ kubectl get pod demo-nginx -o jsonpath='{.spec}' | jq > output.json
$ less output.json
{
  "containers": [
    {
      "image": "nginx",
      "imagePullPolicy": "Always",
      "name": "nginx",
      "resources": {},
...

補足：-o の別利用法

# kubectl get pod <PodName> -o yamlで、設定をそのまま出力できる
$ kubectl get pod demo-nginx -o yaml > output.yaml

【４】Pod削除方法

１）YAML で作ったPodの削除

# kubectl delete -f <YAML>
kubectl delete -f demo_pod.yml

２）kubectl run で作ったPodの削除

# kubectl delete pod <PodName>
$ kubectl delete pod nginx-by-command

Kubernetes ～ Linux / 環境構築編～
https://dk521123.hatenablog.com/entry/2024/01/02/005053
Kubernetes ～ Windows / 環境構築編～
https://dk521123.hatenablog.com/entry/2020/05/01/000000
Kubernetes ～基礎知識編～
https://dk521123.hatenablog.com/entry/2020/04/27/224624
Kubernetes ～入門編～
https://dk521123.hatenablog.com/entry/2020/05/04/013529
Kubernetes ～ Kubernetes Dashboard ～
https://dk521123.hatenablog.com/entry/2023/05/27/144144
Kubernetes ～基本編 / minikube ～
https://dk521123.hatenablog.com/entry/2023/05/07/214515
Kubernetes ～基本編 / kubectlコマンド～
https://dk521123.hatenablog.com/entry/2022/01/12/110555

■ はじめに

目次

【０】トラブル：git pullした際に、エラーが発生

１）エラー内容

２）解決案

【１】git remote prune

【２】使用用途 (【０】の原因)

関連記事

■ はじめに

目次

【１】用語整理

１）setuptools

２）setup.py

【２】setup.pyを使った作成方法

１）ファイル構成

２）コマンドによるパッケージ作成

【３】使い方

１）インストール方法１：ファイルから pip install

２）インストール方法２：GitHubから pip install

３）アンインストール

【４】補足１：init.py の役割

１）「[2] インポートの制御のため」について

２）解決策「all」

参考文献

関連記事

■ はじめに

目次

【１】Pod

【２】Pod作成方法

１）YAML を使ってPod作成

２）kubectl run を使ってPod作成

【３】Pod確認方法

１）kubectl get pod

２）kubectl get pod

【４】Pod削除方法

１）YAML で作ったPodの削除

２）kubectl run で作ったPodの削除

関連記事