day4-不同目錄間模組的呼叫

派森發表於2017-10-26

1.前言

上文已經講述了軟體專案開發目錄規範的若干事項，現在問題來了，我們遵循了專案目錄設計規範，不同目錄下設計了不同的函式和模組，怎麼實現對這些模組的呼叫，使其為專案整體所用呢？本章節講述的絕對路徑與相對路徑，以及不同目錄間模組如何呼叫將回答這個問題。


2.重要功能函式

  1. __file__
    功能：返回檔案自身所在的路徑。
    請注意我們我們一般通過print(__file__)來返回獲得當前檔案所在的路徑，但是不能直接在命令列下以互動的方式來使用它，必須定義在一個儲存好的py檔案中後去執行它。
    image
    命令列下直接使用print(__file__)報錯了！

    另外    這裡的路徑究竟是絕對路徑還是相對路徑呢？答案是兩個都不是，取決於執行時傳遞給python的檔案形式，如果以相對路徑的形式傳遞給python執行，那麼就返回相對路徑，反之則返回絕對路徑。
      1 #  D:/python/S13/Day5/test/bin/test.py 程式碼
  2 print(__file__)
  3 
  4 
  5 # Pycharm執行結果
  6 "C:\Program Files (x86)\python3.6.1\python.exe" D:/python/S13/Day5/test/bin/test.py
  7 D:/python/S13/Day5/test/bin/test.py
  8 
  9 # CMD執行結果
 10 D:\python\S13\Day5\test\bin>python D:/python/S13/Day5/test/bin/test.py  #在檔案所在路徑下以絕對路徑方式傳入檔案，返回的仍然是絕對路徑
 11 D:/python/S13/Day5/test/bin/test.py
 12 D:\python\S13\Day5\test\bin>cd ..
 13 D:\python\S13\Day5\test>python D:/python/S13/Day5/test/bin/test.py
 14 D:/python/S13/Day5/test/bin/test.py
 15 D:\python\S13\Day5\test>cd ..
 16 D:\python\S13\Day5>python test/bin/test.py #只有以相對路徑形式傳入檔案，才能返回相對路徑
 17 test/bin/test.py
  2. os.path.dirname(file)
    功能：返回給定引數檔案所在的目錄(路徑)。
    注意返回的路徑是相對路徑還是絕對路徑取決於傳遞的引數形式，如果以絕對路徑形式傳入引數檔案，則返回絕對路徑，反之則返回相對路徑
      1 >>> print(os.path.abspath('.'))
  2 D:\python\S13\Day5
  3 >>> print(os.path.dirname('test/bin/test.py'))
  4 test/bin
  5 >>> print(os.path.dirname('D:/python/S13/Day5/test/bin/test.py'))
  6 D:/python/S13/Day5/test/bin
  7 
  8 #Pycharm中執行結果相同
  9 #D:/python/S13/Day5/test/bin/test.py程式碼
 10 import os
 11 print(os.path.dirname(os.path.abspath(__file__)))
 12 
 13 #執行結果
 14 "C:\Program Files (x86)\python3.6.1\python.exe" D:/python/S13/Day5/test/bin/test.py
 15 D:\python\S13\Day5\test\bin
 16
  3. os.path.abspath(file)
    功能：返回檔案物件的絕對路徑（包含檔案本身在內）

      1 #test.py程式碼
  2 import os
  3 print(os.path.abspath(__file__))
  4 
  5 #cmd下執行結果
  6 D:\python\S13>python day5/test/bin/test.py
  7 D:\python\S13\day5\test\bin\test.py
  4. sys.path
    功能：返回python當前可執行的環境變數
      1 import sys
  2 print(sys.path)
  3 
  4 D:\python\S13>python day5/test/bin/test.py
  5 ['D:\\python\\S13\\day5\\test\\bin', 'C:\\Program Files (x86)\\python3.6.1\\pyth
  6 on36.zip', 'C:\\Program Files (x86)\\python3.6.1\\DLLs', 'C:\\Program Files (x86
  7 )\\python3.6.1\\lib', 'C:\\Program Files (x86)\\python3.6.1', 'C:\\Program Files
  8  (x86)\\python3.6.1\\lib\\site-packages']
  9

3. 絕對路徑與相對路徑

  • 絕對路徑
    絕對路徑是相當於根目錄而言描述了檔案物件完整的路徑，在任何路徑下通過絕對路徑一定可以找到該檔案。
      1 >>> import os
  2 >>> os.chdir('D:\\python\\S13\\Day5\\test\\bin')
  3 >>> os.listdir()
  4 ['test.py']
  5 >>> os.path.abspath('test.py')
  6 'D:\\python\\S13\\Day5\\test\\bin\\test.py'
  7 >>>
  • 相對路徑
    相對路徑是相對於一個特定的非根目錄而言來描述檔案的路勁的，只有在該指定的參考檔案目錄下通過相對路徑才可以訪問到該檔案。
      1 >>> import os
  2 >>> os.chdir('D:\\python\\S13\\Day5')
  3 >>> os.path.dirname('test/bin/test.py')
  4 'test/bin'  #返回的路徑是相對於當前所在目錄而言的非完整路徑

4. 不同目錄間模組如何呼叫

有了以上基礎知識的鋪墊，就可以實現不同目錄間模組的呼叫了，其實現的思路是先通過上述多個函式把專案根目錄獲取到，然後追加到系統環境變數中，最後from不同路徑import模組。

為什麼要先解決系統環境變數問題呢？這是因為相對於專案而言，預設的PATH只深入到被執行的python檔案所在的目錄這一層。

  1 #test.py程式碼
  2 import sys
  3 print(sys.path)
  4 D:\python\S13>python D:\python\S13\Day5\test\bin\test.py
  5    ['D:\\python\\S13\\Day5\\test\\bin', 'C:\\Program Files (x86)\\python3.6.1\\pyth
  6    on36.zip', 'C:\\Program Files (x86)\\python3.6.1\\DLLs', 'C:\\Program Files (x86
  7    )\\python3.6.1\\lib', 'C:\\Program Files (x86)\\python3.6.1', 'C:\\Program Files
  8     (x86)\\python3.6.1\\lib\\site-packages']
  9 #請注意返回的PATH中，只有列表的第一個元素跟專案本身有關，而且只深入到test.py所在的這一層目錄，其它的元素均為python自身預設的環境變數
 10

因此只能從sys.path返回的列表第一個元素上著手，把專案的根目錄追加到PATH中，這樣才能方便呼叫專案中任何目錄下的模組。
下面通過一個直觀的栗子來實踐一下。

先截圖說明下專案目錄結構：

image
專案的根目錄是test這一級，假設test.py是我的入口檔案。

test.py程式碼如下：

  1 import os,sys
  2 
  3 
  4 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) #這裡先通過os.path.abspath獲取入口檔案所在的絕對路徑，然後通過兩次呼叫os.path.dirname函式獲取到專案根目錄
  5 sys.path.append(BASE_DIR) #把系統根目錄追加到環境變數中
  6 
  7 from conf import settings
  8 settings.check_path()
  9 
 10 from core import main
 11 main.sayhi()

conf/settings.py程式碼如下，用於檢測環境變數是否正確：

  1 import os,sys
  2 
  3 SYS_PATH = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
  4 
  5 def check_path():
  6     print("Let's begin to check the current PATH")
  7     if SYS_PATH in sys.path:
  8         print('Check PATH OK!')
  9     else:
 10         exit('Check PATH error,the program is exiting...')

core/main.py包含了需要執行的主要功能模組，程式碼如下：

  1 def sayhi():
  2     print('Hello world!')

執行test.py的結果如下：

  1 "C:\Program Files (x86)\python3.6.1\python.exe" D:/python/S13/Day5/test/bin/test.py
  2 Let's begin to check the current PATH
  3 Check PATH OK!
  4 Hello world!

可以看到我們獲得了預期的效果，成功實現了對其他目錄下模組的呼叫。

相關文章