python-3.x - 本地目录遮蔽第 3 方包

Question

我试图弄清楚这是否是我的设计中的错误，或者是 redis-py 库中的错误。本质上，我对 Python 中命名空间的理解是，包的设计应该使所有组件都位于包命名空间之下。意思是，如果我在 packageA 中有一个队列，在 packageB 中有一个队列，那么应该不会发生冲突，因为它们是命名空间的(packageA.queue 和 packageB.queue)。但是，我在构建的包中遇到了错误。

这是我正在构建的包的目录结构:

    ○ → tree  
    .  
    ├── __init__.py  
    ├── net  
    │   ├── __init__.py  
    │   ├── rconn.py  
    └── test.py  

__init__.py 文件都是空的。这是我的 test.py 文件的代码:

    ○ → cat test.py
    from net import rconn

这是我的 net/rconn.py 文件中的代码:

    ○ → cat net/rconn.py
    import redis

运行 test.py，一切正常，没有错误。但是，如果我在此处添加一个队列目录并在其中创建一个空的 init.py，则这是新树:

    ○ → tree  
    .  
    ├── __init__.py  
    ├── net  
    │  ├── __init__.py  
    │  ├── rconn.py  
    ├── queue  
    │  ├── __init__.py  
    └── test.py  

运行 test.py 会导致以下错误:

    Traceback (most recent call last):
      File "test.py", line 1, in <module>
        from net.rconn import ass
      File "/Users/yosoyunmaricon/python_test/net/rconn.py", line 1, in <module>
        import redis
      File "/usr/local/lib/python3.7/site-packages/redis/__init__.py", line 1, in <module>
        from redis.client import Redis, StrictRedis
      File "/usr/local/lib/python3.7/site-packages/redis/client.py", line 10, in <module>
        from redis._compat import (b, basestring, bytes, imap, iteritems, iterkeys,
      File "/usr/local/lib/python3.7/site-packages/redis/_compat.py", line 139, in <module>
        from queue import Queue
    ImportError: cannot import name 'Queue' from 'queue' (/Users/yosoyunmaricon/python_test/queue/__init__.py)

所以，我明白发生了什么。 Redis 代码显示 from queue import Queue，当我创建一个空队列目录(即没有队列)时，它会破坏包。我的问题是:这样的设计好吗？ Redis 包是否应该更明确并说出类似于 from redis.queue import Queue 的内容，或者这只是我自己设计中的错误？

Answer 1

这里不应该调整 Redis 包，因为它无法知道或无法处理用户将 Redis 包集成到自己的应用程序中的不同方式，例如您如何拥有类似名称的 queue包裹。此外，没有redis.queue因为queue ，不属于redis的一部分，但是built-in Python queue package 。您可以转到 /usr/local/lib/python3.7/site-packages/redis/_compat.py 并打印出 queue.__file__ ，这将为您提供 Python 的 queue 的路径。它期望导入内置 queue包。

不幸的是，当 Python 构建 module search paths 时为了解决导入问题，它按以下顺序构建:

• The directory containing the input script (or the current directory when no file is specified).
• PYTHONPATH (a list of directory names, with the same syntax as the shell variable PATH).
• The installation-dependent default.

...其中包含您自己的 queue在列表的开头，这就是导入的内容。所以，是的，因为您隐藏了内置的 queue ，所以出现了 ImportError 。更多的是你自己设计的错误。

你可能可以用 sys.path 在这里做一些技巧。或PYTHONPATH ，但是当您可以重命名 queue 时为什么还要麻烦呢？到别的东西。或者，我通常所做的是将我自己的包分组到一个父文件夹中，以项目的首字母缩写词(“abcdlibs”)或一些应用程序标识符或类似“mylibs”之类的内容命名:

.
├── __init__.py
├── mylibs
│   └── queue
│       ├── __init__.py
├── mynet
│   ├── __init__.py
│   └── rconn.py
└── test.py

这样，您就可以清楚地表明 mylibs.queue与 queue 不同.