Question

我有一个非常标准的docker-compose.yml，我需要以编程方式编辑数据库的密码。

由于它是一个YAML文件，我认为编辑和转储内容会很简单。到目前为止，我尝试了PyYAML，它只是弄乱了docker-compose文件，我不知道为什么。

加载和转储相同的内容会破坏结构。

docker-compose.yml的内容：

version: '2'
services:
  web:
    container_name: xxx
    ports:
     - "80:80"
    volumes:
      - .:/xxx
    depends_on:
      - mysql
    build: .
  mysql:
    ports:
     - "32768:32768"
     - "3306:3306"
    container_name: xxx-mysql
    restart: always
    image: mariadb:latest
    environment:
      MYSQL_ROOT_PASSWORD: 'thiswillbechangeonsetupscript'
      MYSQL_DATABASE: 'xxxdb'
    volumes:
     - ./database:/var/lib/mysql
    ports:
      - "3306:3306"

这就是我加载和转储内容的方式：

import yaml

with open("docker-compose.yml", 'r') as ymlfile:
    docker_config = yaml.load(ymlfile)

with open("docker-compose.yml", 'w') as newconf:
    yaml.dump(docker_config, newconf)

这就是文件的保存方式。

services:
  mysql:
    container_name: xxx-mysql
    environment: {MYSQL_DATABASE: xxxdb, MYSQL_ROOT_PASSWORD: thiswillbechangeonsetupscript}
    image: mariadb:latest
    ports: ['3306:3306']
    restart: always
    volumes: ['./database:/var/lib/mysql']
  web:
    build: .
    container_name: xxx
    depends_on: [mysql]
    ports: ['80:80']
    volumes: ['.:/xxx']
version: '2'

有没有更好的方法呢？！我缺少什么？

Answer 1

编写yaml时需要添加default_flow_style=False：

import yaml

with open("docker-compose.yml", 'r') as ymlfile:
    docker_config = yaml.load(ymlfile)

with open("docker-compose_new.yml", 'w') as newconf:
    yaml.dump(docker_config, newconf, default_flow_style=False)

然后你会得到以下作为输出，除了使用字母顺序写行外，它与你的输入类似：

services:
  mysql:
    container_name: xxx-mysql
    environment:
      MYSQL_DATABASE: xxxdb
      MYSQL_ROOT_PASSWORD: thiswillbechangeonsetupscript
    image: mariadb:latest
    ports:
    - 3306:3306
    restart: always
    volumes:
    - ./database:/var/lib/mysql
  web:
    build: .
    container_name: xxx
    depends_on:
    - mysql
    ports:
    - 80:80
    volumes:
    - .:/xxx
version: '2'

请注意，在您的原始docker-compose.yaml中，您声明ports变量两次，因此yaml解析器只会考虑最后一个变量。要解决此问题，请删除以下行：

ports:
  - "3306:3306"

然后，如上所述运行写操作会产生以下输出：

services:
  mysql:
    container_name: xxx-mysql
    environment:
      MYSQL_DATABASE: xxxdb
      MYSQL_ROOT_PASSWORD: thiswillbechangeonsetupscript
    image: mariadb:latest
    ports:
    - 32768:32768
    - 3306:3306
    restart: always
    volumes:
    - ./database:/var/lib/mysql
  web:
    build: .
    container_name: xxx
    depends_on:
    - mysql
    ports:
    - 80:80
    volumes:
    - .:/xxx
version: '2'

Answer 2

PyYAML的默认转储是对叶节点使用流样式（[....]表示序列，{...}表示映射），因此您应该做的最小值是指定yaml.dump(....., default_flow_style=False)

然后YAML规范声明密钥的顺序不能得到保证，你看到的是PyYAML按排序顺序转储它们。

我可以建议使用ruamel.yaml（免责声明：我是该软件包的作者），其特定目标是允许这种往返与输入相比最小的变化，通常没有所有。包括键排序，流程与块样式，字符串引号等。

使用ruamel.yaml还有另一个原因：如果您在输入上运行此程序：

import sys
import ruamel.yaml

yaml = ruamel.yaml.YAML()
yaml.preserve_quotes = True
yaml.indent(sequence=3, offset=1)

with open("docker-compose.yml", 'r') as ymlfile:
    data = yaml.load(ymlfile)
yaml.dump(data, sys.stdout)

您将获得 DuplicateKeyError ：

ruamel.yaml.constructor.DuplicateKeyError: while constructing a mapping
  in "docker-compose.yml", line 13, column 5
found duplicate key "ports" with value "[]" (original value: "[]")
  in "docker-compose.yml", line 24, column 5

因为ports在映射中作为键mysql的值出现两次。根据YAML规范（PyYAML休闲的旧1.1和较新的1.2）不允许这样做，但PyYAML默默地处理第一个键值对，使端口32768未映射。

从输入中删除最后两行后，程序的输出为：

version: '2'
services:
  web:
    container_name: xxx
    ports:
     - "80:80"
    volumes:
     - .:/xxx
    depends_on:
     - mysql
    build: .
  mysql:
    ports:
     - "32768:32768"
     - "3306:3306"
    container_name: xxx-mysql
    restart: always
    image: mariadb:latest
    environment:
      MYSQL_ROOT_PASSWORD: 'thiswillbechangeonsetupscript'
      MYSQL_DATABASE: 'xxxdb'
    volumes:
     - ./database:/var/lib/mysql

希望足够接近您的预期目的。

请注意，PyYAML删除了- "80:80"中的引号，这很好，因为80:80不能被错误地解释为六性，但是如果您对端口25执行某些操作，请将- 80:80更改为{ {1}}使用YAML 1.1解析器（如- 25:25 - docker-compose所做的那样）与- "25:25" (the former equalling - 1525`

大不相同

基于此，我创建了一个实用程序ruamel.dcw，它使用此功能预处理docker compose文件，允许环境变量的默认值（如果没有设置）和其他一些技巧，写出来一个临时文件，然后调用docker-compose -f tmpfile，你应该使用类似的技术，在运行后处理你的临时文件。

使用PyYAML编辑docker-compose.yml

2 个答案: