DEV Community: gyudoza

Easiest way of how to integrate k8s config file

gyudoza — Thu, 10 Nov 2022 15:18:16 +0000

There is a web browser based k8s config merger.
You can visit by use below link.

https://jujumilk3.github.io/k8s-config-merger/

There's no need to explain how to use it. Just drag and drop your config file or files. Then you can copy & paste or just download it.

How to Divide router by Datatype in Path parameter. (FastAPI endpoint Advanced tip.)

gyudoza — Sun, 30 Oct 2022 10:21:12 +0000

How to Divide router by Datatype in Path parameter. (FastAPI endpoint Advanced tip.)

As known as well, FastAPI is almost a framework made of Pydantic and Starlette. So, If these provide something, FastAPI does too. And there's a part that's not in the FastAPI document, but only in Starlette. One of them is the part of endpoint that devided by Pathd's DataType.

from fastapi import FastAPI

app = FastAPI()


@app.get("/items/{item_id}")
async def read_item_by_id(
    item_id: int,
):
    return {"item_id": item_id}


@app.get("/items/{item_name}")
async def read_item_by_name(
    item_name: str,
):
    return {"item_name": item_name}

There is a router configured like this.

When you view an automatically created document,

It looks like this. If you put int in {item_id}, the router above will run, and if you put string in {item_name}, the router below will run.

It works when you input int type but,

But it makes a problem when you input string at item_name. As you can see at the error message, It is said that an error occurred because the value entered in item_id was not an integer, but it can be seen that the endpoint intended by the user is not operated.

from fastapi import FastAPI, Path

app = FastAPI()


@app.get("/items/{item_id}")
async def read_item_by_id(
    item_id: int = Path(0, description="The ID of the item to get"),
):
    return {"item_id": item_id}


@app.get("/items/{item_name}")
async def read_item_by_name(
    item_name: str = Path("", description="The name of the item to get"),
):
    return {"item_name": item_name}

Even if you initialize the default data with the Path type parameter provided by FastAPI,

Inside, it can be seen that the above function (read_item_by_id) that still receives the item_id is executed.

As you can guess, when the FastAPI app runs, the endpoints are sorted inside, and the functions above are higher in priority, so if you write multiple functions on the same endpoint, the function at the top is executed. You can test this simply, too

from fastapi import FastAPI

app = FastAPI()


@app.get("/hello")
async def hello1(
):
    return {"hello": "world1"}


@app.get("/hello")
async def hello2(
):
    return {"hello": "world2"}

If you configure two endpoints with the same name,

The function name appears to be Hello2 and it's like a function that you declared later has priority

If you actually execute it, you will see that the 'hello1' function declared above has been executed.

Now that we know the cause, how do we solve this? It's simple.
In the part where route specifies the path parameter, you can specify the data_type.

from fastapi import FastAPI

app = FastAPI()


@app.get("/items/{item_id:int}")
async def read_item_by_id(
    item_id: int,
):
    print("worked with item_id")
    return {"item_id": item_id}


@app.get("/items/{item_name:str}")
async def read_item_by_name(
    item_name: str,
):
    print("worked with item_name")
    return {"item_name": item_name}

Like this. When you run the router configured in this way, you can see that it works as intended.

If you insert an int, it works as an int router

If you insert a string, it works as a string.

And this way of working with endpoints is not in FastAPI Tutorial. It is in Starlette's. https://www.starlette.io/routing/ You can check it out by referring to this part.

So in the end, in order to make good user of FastAPI, you need to know Pydantic and Starlette, and +@ SqlAlchemy.

How to create python cli app and upload pypi

gyudoza — Mon, 26 Sep 2022 14:56:19 +0000

There's a super simple python cli project i made.
Repository is https://github.com/jujumilk3/python-cli-base

This project made by less 100 line of codes So Very easy to understand how it works. As written, If you wanna create some python cli app, Just fork or copy it and build yours.

Also this app registered at pypi, so you can install and test it.
Just type pip install python-cli-base to install.

yamlier: a Super simple cli yaml editor.

gyudoza — Mon, 25 Apr 2022 13:56:01 +0000

github repository: https://github.com/jujumilk3/yamlier

If you have to edit yaml file on CI/CD pipeline or other situations, just use it.

install

wget https://github.com/jujumilk3/yamlier/releases/download/v0.2.0/yamlier.{os}.{arcihtecture} -O ./yamlier

chmod +x ./yamlier

Of course, if you want to use it globally, You have to move it into bin dir
that referenced by your account.

for example

MacOS(amd64) ```shell

$ wget https://github.com/jujumilk3/yamlier/releases/download/v0.2.0/yamlier.darwin.amd64 -O ./yamlier
chmod +x ./yamlier
./yamlier edit ./yamlier edit developer.yaml languages.perl poor ./developer-modified.yaml

2. github actions (github actions' ubuntu-latest image is amd64 architecture)
   ```yaml


...
jobs:
  build:
    runs-on: ubuntu-latest
...
    - name: wget
      uses: wei/wget@v1
      with:
        args: https://github.com/jujumilk3/yamlier/releases/download/v0.2.0/yamlier.linux.amd64 -O yamlier

    - name: change file mod
      run: sudo chmod +x ./yamlier

    - name: run yamlier
      run: ./yamlier edit ./developer.yaml name changed_name ./developer-yamlier.yaml
...

usage

yamlier --help
yamlier edit [flags]
1. yamlier edit [file_path] [key] [value] | [output_filepath]

example



# developer.yaml
name: Martin D'vloper
job: Developer
skill: Elite
foods:
  - Apple
  - Orange
  - Strawberry
  - Mango
languages:
  perl: Elite
  python: Elite
  pascal: Lame
education: |
  4 GCSEs
  3 A-Levels
  BSc in the Internet of Things

yamlier edit ./developer.yaml name changed_name ./developer-yamlier.yaml



# developer-yamlier.yaml
education: |
  4 GCSEs
  3 A-Levels
  BSc in the Internet of Things
foods:
- Apple
- Orange
- Strawberry
- Mango
job: Developer
languages:
  pascal: Lame
  perl: Elite
  python: Elite
name: changed_name  # name changed
skill: Elite

※ CAUTION: new yaml's keys are ordered.

Also, you can handle deeper values



# developer.yaml
name: Martin D'vloper
job: Developer
skill: Elite
foods:
  - Apple
  - Orange
  - Strawberry
  - Mango
languages:
  perl: Elite
  python: Elite
  pascal: Lame
education: |
  4 GCSEs
  3 A-Levels
  BSc in the Internet of Things

yamlier edit ./developer.yaml languages.perl Poor ./developer-yamlier.yaml



# developer-yamlier.yaml
education: |
  4 GCSEs
  3 A-Levels
  BSc in the Internet of Things
foods:
- Apple
- Orange
- Strawberry
- Mango
job: Developer
languages:
  pascal: Lame
  perl: Poor  # languages.perl changed
  python: Elite
name: Martin D'vloper
skill: Elite

I made it because i had to edit my yaml config file on CI/CD pipeline. There were some values that should not be exposed. I thought there is some cli tool that edits yaml file. Because kustomize actually does it. But there's no yaml editing cli tool.

Everyone who needs to edit yaml file at cli is writing temporary bash, shell, python script to edit yaml file.

Don't complicate things. Use this.