使用 Python 创建你自己的 Shell (上)

我很想知道一个 shell (像 bash,csh 等)内部是如何工作的。于是为了满足自己的好奇心,我使用 Python 实现了一个名为 yosh (Your Own Shell)的 Shell。本文章所介绍的概念也可以应用于其他编程语言。

(提示:你可以在这里查找本博文使用的源代码,代码以 MIT 许可证发布。在 Mac OS X 10.11.5 上,我使用 Python 2.7.10 和 3.4.3 进行了测试。它应该可以运行在其他类 Unix 环境,比如 Linux 和 Windows 上的 Cygwin。)

让我们开始吧。

步骤 0:项目结构

对于此项目,我使用了以下的项目结构。


  1. yosh_project
  2. |-- yosh
  3. |-- __init__.py
  4. |-- shell.py

yosh_project 为项目根目录(你也可以把它简单命名为 yosh)。

yosh 为包目录,且 __init__.py 可以使它成为与包的目录名字相同的包(如果你不用 Python 编写的话,可以忽略它。)

shell.py 是我们主要的脚本文件。

步骤 1:Shell 循环

当启动一个 shell,它会显示一个命令提示符并等待你的命令输入。在接收了输入的命令并执行它之后(稍后文章会进行详细解释),你的 shell 会重新回到这里,并循环等待下一条指令。

在 shell.py 中,我们会以一个简单的 main 函数开始,该函数调用了 shell_loop() 函数,如下:


  1. def shell_loop():
  2. # Start the loop here
  3. def main():
  4. shell_loop()
  5. if __name__ == "__main__":
  6. main()

接着,在 shell_loop() 中,为了指示循环是否继续或停止,我们使用了一个状态标志。在循环的开始,我们的 shell 将显示一个命令提示符,并等待读取命令输入。


  1. import sys
  2. SHELL_STATUS_RUN = 1
  3. SHELL_STATUS_STOP = 0
  4. def shell_loop():
  5. status = SHELL_STATUS_RUN
  6. while status == SHELL_STATUS_RUN:
  7. ### 显示命令提示符
  8. sys.stdout.write('> ')
  9. sys.stdout.flush()
  10. ### 读取命令输入
  11. cmd = sys.stdin.readline()

之后,我们切分命令tokenize输入并进行执行execute(我们即将实现 tokenize 和 execute 函数)。

因此,我们的 shell_loop() 会是如下这样:


  1. import sys
  2. SHELL_STATUS_RUN = 1
  3. SHELL_STATUS_STOP = 0
  4. def shell_loop():
  5. status = SHELL_STATUS_RUN
  6. while status == SHELL_STATUS_RUN:
  7. ### 显示命令提示符
  8. sys.stdout.write('> ')
  9. sys.stdout.flush()
  10. ### 读取命令输入
  11. cmd = sys.stdin.readline()
  12. ### 切分命令输入
  13. cmd_tokens = tokenize(cmd)
  14. ### 执行该命令并获取新的状态
  15. status = execute(cmd_tokens)

这就是我们整个 shell 循环。如果我们使用 python shell.py 启动我们的 shell,它会显示命令提示符。然而如果我们输入命令并按回车,它会抛出错误,因为我们还没定义 tokenize 函数。

为了退出 shell,可以尝试输入 ctrl-c。稍后我将解释如何以优雅的形式退出 shell。

步骤 2:命令切分tokenize

当用户在我们的 shell 中输入命令并按下回车键,该命令将会是一个包含命令名称及其参数的长字符串。因此,我们必须切分该字符串(分割一个字符串为多个元组)。

咋一看似乎很简单。我们或许可以使用 cmd.split(),以空格分割输入。它对类似 ls -a my_folder 的命令起作用,因为它能够将命令分割为一个列表 ['ls', '-a', 'my_folder'],这样我们便能轻易处理它们了。

然而,也有一些类似 echo "Hello World" 或 echo 'Hello World' 以单引号或双引号引用参数的情况。如果我们使用 cmd.spilt,我们将会得到一个存有 3 个标记的列表 ['echo', '"Hello', 'World"'] 而不是 2 个标记的列表 ['echo', 'Hello World']

幸运的是,Python 提供了一个名为 shlex 的库,它能够帮助我们如魔法般地分割命令。(提示:我们也可以使用正则表达式,但它不是本文的重点。)


  1. import sys
  2. import shlex
  3. ...
  4. def tokenize(string):
  5. return shlex.split(string)
  6. ...

然后我们将这些元组发送到执行进程。

步骤 3:执行

这是 shell 中核心而有趣的一部分。当 shell 执行 mkdir test_dir 时,到底发生了什么?(提示: mkdir是一个带有 test_dir 参数的执行程序,用于创建一个名为 test_dir 的目录。)

execvp 是这一步的首先需要的函数。在我们解释 execvp 所做的事之前,让我们看看它的实际效果。


  1. import os
  2. ...
  3. def execute(cmd_tokens):
  4. ### 执行命令
  5. os.execvp(cmd_tokens[0], cmd_tokens)
  6. ### 返回状态以告知在 shell_loop 中等待下一个命令
  7. return SHELL_STATUS_RUN
  8. ...

再次尝试运行我们的 shell,并输入 mkdir test_dir 命令,接着按下回车键。

在我们敲下回车键之后,问题是我们的 shell 会直接退出而不是等待下一个命令。然而,目录正确地创建了。

因此,execvp 实际上做了什么?

execvp 是系统调用 exec 的一个变体。第一个参数是程序名字。v 表示第二个参数是一个程序参数列表(参数数量可变)。p 表示将会使用环境变量 PATH 搜索给定的程序名字。在我们上一次的尝试中,它将会基于我们的 PATH 环境变量查找mkdir 程序。

(还有其他 exec 变体,比如 execv、execvpe、execl、execlp、execlpe;你可以 google 它们获取更多的信息。)

exec 会用即将运行的新进程替换调用进程的当前内存。在我们的例子中,我们的 shell 进程内存会被替换为mkdir 程序。接着,mkdir 成为主进程并创建 test_dir 目录。最后该进程退出。

这里的重点在于我们的 shell 进程已经被 mkdir 进程所替换。这就是我们的 shell 消失且不会等待下一条命令的原因。

因此,我们需要其他的系统调用来解决问题:fork

fork 会分配新的内存并拷贝当前进程到一个新的进程。我们称这个新的进程为子进程,调用者进程为父进程。然后,子进程内存会被替换为被执行的程序。因此,我们的 shell,也就是父进程,可以免受内存替换的危险。

让我们看看修改的代码。


  1. ...
  2. def execute(cmd_tokens):
  3. ### 分叉一个子 shell 进程
  4. ### 如果当前进程是子进程,其 `pid` 被设置为 `0`
  5. ### 否则当前进程是父进程的话,`pid` 的值
  6. ### 是其子进程的进程 ID。
  7. pid = os.fork()
  8. if pid == 0:
  9. ### 子进程
  10. ### 用被 exec 调用的程序替换该子进程
  11. os.execvp(cmd_tokens[0], cmd_tokens)
  12. elif pid > 0:
  13. ### 父进程
  14. while True:
  15. ### 等待其子进程的响应状态(以进程 ID 来查找)
  16. wpid, status = os.waitpid(pid, 0)
  17. ### 当其子进程正常退出时
  18. ### 或者其被信号中断时,结束等待状态
  19. if os.WIFEXITED(status) or os.WIFSIGNALED(status):
  20. break
  21. ### 返回状态以告知在 shell_loop 中等待下一个命令
  22. return SHELL_STATUS_RUN
  23. ...

当我们的父进程调用 os.fork() 时,你可以想象所有的源代码被拷贝到了新的子进程。此时此刻,父进程和子进程看到的是相同的代码,且并行运行着。

如果运行的代码属于子进程,pid 将为 0。否则,如果运行的代码属于父进程,pid 将会是子进程的进程 id。

当 os.execvp 在子进程中被调用时,你可以想象子进程的所有源代码被替换为正被调用程序的代码。然而父进程的代码不会被改变。

当父进程完成等待子进程退出或终止时,它会返回一个状态,指示继续 shell 循环。

运行

现在,你可以尝试运行我们的 shell 并输入 mkdir test_dir2。它应该可以正确执行。我们的主 shell 进程仍然存在并等待下一条命令。尝试执行 ls,你可以看到已创建的目录。

原文发布时间为:2016-07-28

本文来自合作伙伴“Linux中国”

时间: 2024-11-02 11:51:57

使用 Python 创建你自己的 Shell (上)的相关文章

使用 Python 创建你自己的 Shell(下)

在上篇中,我们已经创建了一个 shell 主循环.切分了命令输入,以及通过 fork 和 exec 执行命令.在这部分,我们将会解决剩下的问题.首先,cd test_dir2 命令无法修改我们的当前目录.其次,我们仍无法优雅地从 shell 中退出. 步骤 4:内置命令 "cd test_dir2 无法修改我们的当前目录" 这句话是对的,但在某种意义上也是错的.在执行完该命令之后,我们仍然处在同一目录,从这个意义上讲,它是对的.然而,目录实际上已经被修改,只不过它是在子进程中被修改.

Python创建模块及模块导入的方法

  本文实例讲述了Python创建模块及模块导入的方法.分享给大家供大家参考.具体分析如下: python学习手册中写道: 定义模块,只要使用文本编辑器,把一些python代码输入到文本中,然后以.py为后缀名进行保存,任何此类文件都会被认为是python模块. 比如说,下面的代码输入到一个文件中,就可以看作是一个模块: ? 1 2 3 4 def printme(var): print var if __name__ == '__main__': printme(1) 假设说输入到a.py中,

利用Python脚本在Nginx和uwsgi上部署MoinMoin的教程

  这篇文章主要介绍了利用Python脚本在Nginx和uwsgi上部署MoinMoin的教程,示例基于CentOS操作系统,需要的朋友可以参考下 在 CentOS 下使用 apache+mod_wsgi 部署了 MoinMoin,但是编辑和保存页面很慢,于是准备使用 nginx+uwsgi 重新部署 本文假定已经按照官方指引 Quick MoinMoin on CentOS 完成了 apache 和 mod_wsgi 之外的基础安装 安装 Nginx 默认情况下,CentOS 下没有 ngin

python创建进程fork用法

  本文实例讲述了python创建进程fork用法.分享给大家供大家参考.具体分析如下: ? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 #!coding=utf-8 import os ,traceback import time ''' fork()系统调用是Unix下以自身进程创建子进程的系统调用, 一次调用,两次返回,如果返回是0, 则是子进程,如果返回值>0,则是父进程(返回

python创建一个最简单http webserver服务器的方法

  这篇文章主要介绍了python创建一个最简单http webserver服务器的方法,实例分析了Python操作http创建服务器端的相关技巧,需要的朋友可以参考下 ? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 import sys import BaseHTTPServer from SimpleHTTPServer import SimpleHTTPRequestHandler Handler = SimpleHTTPRequestHandler Serve

Python实现一个简单的能够上传下载的HTTP服务器

这篇文章主要介绍了用Python实现一个简单的能够上传下载的HTTP服务器,是Python网络编程学习当中的基础,本文示例基于Windows操作系统实现,需要的朋友可以参考下 ? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 5

xib创建的view,该view上的button 不能点击?

问题描述 xib创建的view,该view上的button 不能点击? FengView *feng = [[NSBundle mainBundle]loadNibNamed:@"FengView" owner:self options:nil][0]; [self.view addSubview:feng]; 解决方案 给button设置一下tag,然后使用[feng viewWithTag]获得button,再将button调用addTarget手动设置点击事件就可以了.

Python创建系统目录的方法_python

本文实例讲述了Python创建系统目录的方法.分享给大家供大家参考.具体如下: Python2 mkdir在没有上级目录时创建会失败.该方法可以创建多级目录. /temp/gapgers/upload/images/1.png 如过temp文件夹不存在,会创建空的文件夹/temp/gapgers/upload/images/以及空文件1.png. 该方法只做抛砖引玉,大神勿喷 复制代码 代码如下: import os     def mkfilePower(path):       '''cre

Python创建xml的方法_python

本文实例讲述了Python创建xml的方法.分享给大家供大家参考.具体实现方法如下: from xml.dom.minidom import Document class write_xml(Document): def __init__(self): Document.__init__(self) def set_tag(self,tag): self.tag = tag self.tag1 = self.createElement(self.tag) self.appendChild(sel