ModuleNotFoundError: 在Airflow中找不到模块名称 ‘gspread’

huangapple go评论120阅读模式
英文:

ModuleNotFoundError: No module named 'gspread' in Airflow

问题

You are encountering a "ModuleNotFoundError: No module named 'gspread'" error in your Airflow DAG. This issue is related to the Python environment used by Airflow not having the 'gspread' library installed. Here's how you can resolve it:

  1. Install 'gspread' in the Airflow Environment:

    In your Docker setup, you need to make sure that the 'gspread' library is installed in the Python environment used by Airflow. You can add it to your Docker image's requirements. To do this:

    a. Open the Dockerfile used to build your Airflow image (the one mentioned as image in your Docker Compose file).

    b. Look for the section where Python packages are installed (usually using pip). It might look something like this:

    1. # Install additional Python packages
    2. RUN pip install package1 package2 ...

    c. Add 'gspread' to the list of packages to install:

    1. RUN pip install package1 package2 gspread ...
  2. Rebuild Your Airflow Image:

    After modifying the Dockerfile, you need to rebuild your Airflow Docker image to include the 'gspread' library. You can do this using the docker-compose build command:

    1. docker-compose build
  3. Restart Airflow:

    Once you've rebuilt the image, you should restart your Airflow containers to apply the changes:

    1. docker-compose up -d

    This will recreate the Airflow containers with the updated image that includes 'gspread.'

  4. Retry Your DAG:

    After the containers are up and running, try running your DAG again. The 'gspread' library should now be available in your Airflow environment, and the import error should be resolved.

Make sure you've followed these steps correctly, and if you encounter any issues during the process, please provide more details for further assistance.

英文:

I am running a defautl airflow image version 2.5.1 on docker and I am trying to create a DAG in order to send data to a google gsheets. I already have the credentials and I've tested it and it is ok with that. I've created an env, my OS is windows and my python version is 3.10.2. That's my code:

  1. from airflow import DAG
  2. from airflow.providers.google.common.hooks.base_google import GoogleBaseHook
  3. from df2gspread import df2gspread
  4. import gspread
  5. from datetime import datetime
  6. default_args = {
  7. 'owner': 'airflow',
  8. 'start_date': datetime(2023, 1, 1)
  9. }
  10. with DAG(
  11. dag_id="test",
  12. start_date=datetime.now(),
  13. schedule_interval="@daily",
  14. ) as dag:
  15. @dag.task
  16. def test_dag():
  17. # Create a hook object
  18. # When using the google_cloud_default we can use
  19. # hook = GoogleBaseHook()
  20. # Or for a deligate use: GoogleBaseHook(delegate_to='foo@bar.com')
  21. hook = GoogleBaseHook(gcp_conn_id='google_conn_id')
  22. # Get the credentials
  23. credentials = hook.get_credentials()
  24. print(credentials)
  25. # Optional, set the delegate email if needed later.
  26. # You need a domain wide delegate service account to use this.
  27. #credentials = credentials.with_subject('foo@bar.com')
  28. # Use the credentials to authenticate the gspread client
  29. gc = gspread.Client(auth=credentials)
  30. # # Create Spreadsheet
  31. gc.create('example')
  32. gc.list_spreadsheet_files()
  33. test_dag()

And this is the docker image:

  1. # Licensed to the Apache Software Foundation (ASF) under one
  2. # or more contributor license agreements. See the NOTICE file
  3. # distributed with this work for additional information
  4. # regarding copyright ownership. The ASF licenses this file
  5. # to you under the Apache License, Version 2.0 (the
  6. # "License"); you may not use this file except in compliance
  7. # with the License. You may obtain a copy of the License at
  8. #
  9. # http://www.apache.org/licenses/LICENSE-2.0
  10. #
  11. # Unless required by applicable law or agreed to in writing,
  12. # software distributed under the License is distributed on an
  13. # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  14. # KIND, either express or implied. See the License for the
  15. # specific language governing permissions and limitations
  16. # under the License.
  17. #
  18. # Basic Airflow cluster configuration for CeleryExecutor with Redis and PostgreSQL.
  19. #
  20. # WARNING: This configuration is for local development. Do not use it in a production deployment.
  21. #
  22. # This configuration supports basic configuration using environment variables or an .env file
  23. # The following variables are supported:
  24. #
  25. # AIRFLOW_IMAGE_NAME - Docker image name used to run Airflow.
  26. # Default: apache/airflow:2.5.1
  27. # AIRFLOW_UID - User ID in Airflow containers
  28. # Default: 50000
  29. # AIRFLOW_PROJ_DIR - Base path to which all the files will be volumed.
  30. # Default: .
  31. # Those configurations are useful mostly in case of standalone testing/running Airflow in test/try-out mode
  32. #
  33. # _AIRFLOW_WWW_USER_USERNAME - Username for the administrator account (if requested).
  34. # Default: airflow
  35. # _AIRFLOW_WWW_USER_PASSWORD - Password for the administrator account (if requested).
  36. # Default: airflow
  37. # _PIP_ADDITIONAL_REQUIREMENTS - Additional PIP requirements to add when starting all containers.
  38. # Default: ''
  39. #
  40. # Feel free to modify this file to suit your needs.
  41. ---
  42. version: '3'
  43. x-airflow-common:
  44. &airflow-common
  45. # In order to add custom dependencies or upgrade provider packages you can use your extended image.
  46. # Comment the image line, place your Dockerfile in the directory where you placed the docker-compose.yaml
  47. # and uncomment the "build" line below, Then run `docker-compose build` to build the images.
  48. image: ${AIRFLOW_IMAGE_NAME:-apache/airflow:2.5.1}
  49. # build: .
  50. environment:
  51. &airflow-common-env
  52. AIRFLOW__CORE__EXECUTOR: CeleryExecutor
  53. AIRFLOW__DATABASE__SQL_ALCHEMY_CONN: postgresql+psycopg2://airflow:airflow@postgres/airflow
  54. # For backward compatibility, with Airflow <2.3
  55. AIRFLOW__CORE__SQL_ALCHEMY_CONN: postgresql+psycopg2://airflow:airflow@postgres/airflow
  56. AIRFLOW__CELERY__RESULT_BACKEND: db+postgresql://airflow:airflow@postgres/airflow
  57. AIRFLOW__CELERY__BROKER_URL: redis://:@redis:6379/0
  58. AIRFLOW__CORE__FERNET_KEY: ''
  59. AIRFLOW__CORE__DAGS_ARE_PAUSED_AT_CREATION: 'true'
  60. AIRFLOW__CORE__LOAD_EXAMPLES: 'false'
  61. AIRFLOW__API__AUTH_BACKENDS: 'airflow.api.auth.backend.basic_auth,airflow.api.auth.backend.session'
  62. _PIP_ADDITIONAL_REQUIREMENTS: ${_PIP_ADDITIONAL_REQUIREMENTS:-}
  63. volumes:
  64. - ${AIRFLOW_PROJ_DIR:-.}/dags:/opt/airflow/dags
  65. - ${AIRFLOW_PROJ_DIR:-.}/logs:/opt/airflow/logs
  66. - ${AIRFLOW_PROJ_DIR:-.}/plugins:/opt/airflow/plugins
  67. user: "${AIRFLOW_UID:-50000}:0"
  68. depends_on:
  69. &airflow-common-depends-on
  70. redis:
  71. condition: service_healthy
  72. postgres:
  73. condition: service_healthy
  74. services:
  75. postgres:
  76. image: postgres:13
  77. environment:
  78. POSTGRES_USER: airflow
  79. POSTGRES_PASSWORD: airflow
  80. POSTGRES_DB: airflow
  81. volumes:
  82. - postgres-db-volume:/var/lib/postgresql/data
  83. healthcheck:
  84. test: ["CMD", "pg_isready", "-U", "airflow"]
  85. interval: 5s
  86. retries: 5
  87. restart: always
  88. redis:
  89. image: redis:latest
  90. expose:
  91. - 6379
  92. healthcheck:
  93. test: ["CMD", "redis-cli", "ping"]
  94. interval: 5s
  95. timeout: 30s
  96. retries: 50
  97. restart: always
  98. airflow-webserver:
  99. <<: *airflow-common
  100. command: webserver
  101. ports:
  102. - 8080:8080
  103. healthcheck:
  104. test: ["CMD", "curl", "--fail", "http://localhost:8080/health"]
  105. interval: 10s
  106. timeout: 10s
  107. retries: 5
  108. restart: always
  109. depends_on:
  110. <<: *airflow-common-depends-on
  111. airflow-init:
  112. condition: service_completed_successfully
  113. airflow-scheduler:
  114. <<: *airflow-common
  115. command: scheduler
  116. healthcheck:
  117. test: ["CMD-SHELL", 'airflow jobs check --job-type SchedulerJob --hostname "$${HOSTNAME}"']
  118. interval: 10s
  119. timeout: 10s
  120. retries: 5
  121. restart: always
  122. depends_on:
  123. <<: *airflow-common-depends-on
  124. airflow-init:
  125. condition: service_completed_successfully
  126. airflow-worker:
  127. <<: *airflow-common
  128. command: celery worker
  129. healthcheck:
  130. test:
  131. - "CMD-SHELL"
  132. - 'celery --app airflow.executors.celery_executor.app inspect ping -d "celery@$${HOSTNAME}"'
  133. interval: 10s
  134. timeout: 10s
  135. retries: 5
  136. environment:
  137. <<: *airflow-common-env
  138. # Required to handle warm shutdown of the celery workers properly
  139. # See https://airflow.apache.org/docs/docker-stack/entrypoint.html#signal-propagation
  140. DUMB_INIT_SETSID: "0"
  141. restart: always
  142. depends_on:
  143. <<: *airflow-common-depends-on
  144. airflow-init:
  145. condition: service_completed_successfully
  146. airflow-triggerer:
  147. <<: *airflow-common
  148. command: triggerer
  149. healthcheck:
  150. test: ["CMD-SHELL", 'airflow jobs check --job-type TriggererJob --hostname "$${HOSTNAME}"']
  151. interval: 10s
  152. timeout: 10s
  153. retries: 5
  154. restart: always
  155. depends_on:
  156. <<: *airflow-common-depends-on
  157. airflow-init:
  158. condition: service_completed_successfully
  159. airflow-init:
  160. <<: *airflow-common
  161. entrypoint: /bin/bash
  162. # yamllint disable rule:line-length
  163. command:
  164. - -c
  165. - |
  166. function ver() {
  167. printf "%04d%04d%04d%04d" $${1//./ }
  168. }
  169. airflow_version=$$(AIRFLOW__LOGGING__LOGGING_LEVEL=INFO && gosu airflow airflow version)
  170. airflow_version_comparable=$$(ver $${airflow_version})
  171. min_airflow_version=2.2.0
  172. min_airflow_version_comparable=$$(ver $${min_airflow_version})
  173. if (( airflow_version_comparable < min_airflow_version_comparable )); then
  174. echo
  175. echo -e "\033[1;31mERROR!!!: Too old Airflow version $${airflow_version}!\e[0m"
  176. echo "The minimum Airflow version supported: $${min_airflow_version}. Only use this or higher!"
  177. echo
  178. exit 1
  179. fi
  180. if [[ -z "${AIRFLOW_UID}" ]]; then
  181. echo
  182. echo -e "\033[1;33mWARNING!!!: AIRFLOW_UID not set!\e[0m"
  183. echo "If you are on Linux, you SHOULD follow the instructions below to set "
  184. echo "AIRFLOW_UID environment variable, otherwise files will be owned by root."
  185. echo "For other operating systems you can get rid of the warning with manually created .env file:"
  186. echo " See: https://airflow.apache.org/docs/apache-airflow/stable/howto/docker-compose/index.html#setting-the-right-airflow-user"
  187. echo
  188. fi
  189. one_meg=1048576
  190. mem_available=$$(($$(getconf _PHYS_PAGES) * $$(getconf PAGE_SIZE) / one_meg))
  191. cpus_available=$$(grep -cE 'cpu[0-9]+' /proc/stat)
  192. disk_available=$$(df / | tail -1 | awk '{print $$4}')
  193. warning_resources="false"
  194. if (( mem_available < 4000 )) ; then
  195. echo
  196. echo -e "\033[1;33mWARNING!!!: Not enough memory available for Docker.\e[0m"
  197. echo "At least 4GB of memory required. You have $$(numfmt --to iec $$((mem_available * one_meg)))"
  198. echo
  199. warning_resources="true"
  200. fi
  201. if (( cpus_available < 2 )); then
  202. echo
  203. echo -e "\033[1;33mWARNING!!!: Not enough CPUS available for Docker.\e[0m"
  204. echo "At least 2 CPUs recommended. You have $${cpus_available}"
  205. echo
  206. warning_resources="true"
  207. fi
  208. if (( disk_available < one_meg * 10 )); then
  209. echo
  210. echo -e "\033[1;33mWARNING!!!: Not enough Disk space available for Docker.\e[0m"
  211. echo "At least 10 GBs recommended. You have $$(numfmt --to iec $$((disk_available * 1024 )))"
  212. echo
  213. warning_resources="true"
  214. fi
  215. if [[ $${warning_resources} == "true" ]]; then
  216. echo
  217. echo -e "\033[1;33mWARNING!!!: You have not enough resources to run Airflow (see above)!\e[0m"
  218. echo "Please follow the instructions to increase amount of resources available:"
  219. echo " https://airflow.apache.org/docs/apache-airflow/stable/howto/docker-compose/index.html#before-you-begin"
  220. echo
  221. fi
  222. mkdir -p /sources/logs /sources/dags /sources/plugins
  223. chown -R "${AIRFLOW_UID}:0" /sources/{logs,dags,plugins}
  224. exec /entrypoint airflow version
  225. # yamllint enable rule:line-length
  226. environment:
  227. <<: *airflow-common-env
  228. _AIRFLOW_DB_UPGRADE: 'true'
  229. _AIRFLOW_WWW_USER_CREATE: 'true'
  230. _AIRFLOW_WWW_USER_USERNAME: ${_AIRFLOW_WWW_USER_USERNAME:-airflow}
  231. _AIRFLOW_WWW_USER_PASSWORD: ${_AIRFLOW_WWW_USER_PASSWORD:-airflow}
  232. _PIP_ADDITIONAL_REQUIREMENTS: ''
  233. user: "0:0"
  234. volumes:
  235. - ${AIRFLOW_PROJ_DIR:-.}:/sources
  236. airflow-cli:
  237. <<: *airflow-common
  238. profiles:
  239. - debug
  240. environment:
  241. <<: *airflow-common-env
  242. CONNECTION_CHECK_MAX_COUNT: "0"
  243. # Workaround for entrypoint issue. See: https://github.com/apache/airflow/issues/16252
  244. command:
  245. - bash
  246. - -c
  247. - airflow
  248. # You can enable flower by adding "--profile flower" option e.g. docker-compose --profile flower up
  249. # or by explicitly targeted on the command line e.g. docker-compose up flower.
  250. # See: https://docs.docker.com/compose/profiles/
  251. flower:
  252. <<: *airflow-common
  253. command: celery flower
  254. profiles:
  255. - flower
  256. ports:
  257. - 5555:5555
  258. healthcheck:
  259. test: ["CMD", "curl", "--fail", "http://localhost:5555/"]
  260. interval: 10s
  261. timeout: 10s
  262. retries: 5
  263. restart: always
  264. depends_on:
  265. <<: *airflow-common-depends-on
  266. airflow-init:
  267. condition: service_completed_successfully
  268. volumes:
  269. postgres-db-volume:

When I initialize airflow on localhost, I keep getting import errors on my DAG, indicating ModuleNotFoundError: No module named 'gspread'.

I've read some questions made here on stack overflow about that issue, and I've already tried creating an env, I've tried installing the library with pip install gspread, pip3 install gspread and none has worked.

答案1

得分: 0

你的问题是:Airflow的Docker镜像不包含gspread包。

这意味着当你启动Airflow的Docker镜像时,它会尝试加载你的代码,但此时你的代码尝试导入gspread,但该包未安装在Docker镜像中,因此失败。

简而言之:当使用Airflow的Docker镜像时,你只能使用Airflow提供的包和由Airflow提供的包。gspread不是Airflow提供的。

你需要做的是:创建一个名为Dockerfile的文件。

将Airflow镜像用作基础镜像(使用指令:FROM apache/airflow:2.5.1)。

然后安装gspread。使用以下指令:RUN pip install gspread

然后保存该文件并更新你的Docker Compose,以便使用你的自定义镜像而不是原始镜像。

为此,只需更新Docker Compose文件,注释掉下面的行:

  1. image: ${AIRFLOW_IMAGE_NAME:-apache/airflow:2.5.1}

然后取消注释下面的行:

  1. build: .

如果出现任何问题,请回到这里,我们将进行必要的调整。

英文:

Your issue is: the airflow docker image does not contain the package gspread.

That means when you start the airflow docker image it tries to load your code, at that point you code tries to import gspread but it's not installed in the docker image so it fails.

In a nutshell: when using airflow docker image you can only use airflow packages and packages provided by airflow. gspread is not provided by airflow.

What you need is: create a file named Dockerfile

Use the airflow image as a base image (using the instruction: FROM apache/airflow:2.5.1)

Then install gspread. Using the following instruction: RUN pip install gspread

Then save the file and update your docker compose so it uses your custom image instead of the original image.

For that simply update the docker compose file, comment the line bellow

  1. image: ${AIRFLOW_IMAGE_NAME:-apache/airflow:2.5.1}

Then uncomment the line bellow:

  1. build: .

In case of any issue come back here will adjust what need be.

huangapple
  • 本文由 发表于 2023年7月6日 19:59:14
  • 转载请务必保留本文链接:https://go.coder-hub.com/76628597.html
匿名

发表评论

匿名网友

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

确定