# Python Modules Primer

## Prerequisites

These instructions assume a Linux environment.
A macOS environment is similar, but not identical.
A Windows environment is more different.

## Previous knowledge

### A refresher on the `PATH` variable

If you execute the following command in your terminal:

```
$ echo hello
```

, the shell searches for the `echo` command in the directories listed in your `PATH` environment variable.
You can display your `PATH` variable by running:

```
$ echo $PATH
/home/user/.local/bin:/home/user/bin:/usr/share/Modules/bin:/usr/local/bin:/usr/local/sbin:/usr/bin:/usr/sbin
```

The contents of the `PATH` variable depend on your particular environment.

If you run the following command:

```
$ which echo
/usr/bin/echo
```

The `which` command prints where the shell locates the `echo` command.

### A refresher on shell scripts

If you create a file named `foo.sh` with the following contents:

```
#!/bin/sh

echo hello
```

You define a "shell script".
The first line indicates that this shell script is executed by using the `/bin/sh` command.
The rest of the file are commands to be executed by the shell command.
These commands behave as if you typed them into your terminal, so if you execute this script, the command `echo hello` will be executed, printing `hello`.

If you try to run `foo.sh` like you run the `echo` command, by typing its name, it does not work:

```
$ foo.sh
bash: foo.sh: command not found...
```

, because the shell looks for the `foo.sh` in the directories listed in the `PATH` variable.
Unless you created the `foo.sh` file in a directory like `/usr/bin`, the shell will not find the `foo.sh` command.

A solution to this problem is to specify the path to the `foo.sh` file, instead of relying on the `PATH` variable.
However, if you do this, you face a second problem.

```
$ ./foo.sh
bash: ./foo.sh: Permission denied
```

This happens because only files with the executable permission can be executed in this way.
To solve this, add the executable permission; then it works:

```
$ chmod +x foo.sh
$ ./foo.sh
hello
```

## The `import` statement in Python

### Importing from the Python standard library

Run the following commands by using the Python REPL:

```
$ python3
Python 3.9.17 (main, Aug  9 2023, 00:00:00)
[GCC 11.4.1 20230605 (Red Hat 11.4.1-2)] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import datetime
>>> datetime.datetime.now()
datetime.datetime(2023, 9, 11, 21, 53, 16, 331236)
```

`import` works in a similar way to running a command in the shell.
Python searches a number of directories looking for the `datetime` module.

To see which directories are searched, run:

```
$ python3
>>> import sys
>>> sys.path
['', '/usr/lib64/python39.zip', '/usr/lib64/python3.9', '/usr/lib64/python3.9/lib-dynload', '/home/alex/.local/lib/python3.9/site-packages', '/usr/lib64/python3.9/site-packages', '/usr/lib/python3.9/site-packages']
```

`sys.path` is a list of the directories that the `import` command searches.
The contents of `sys.path` depend on your operating system and Python installation method.

In my system, the `/usr/lib64/python3.9` directory contains the `datetime.py` module.

```
$ head /usr/lib64/python3.9/datetime.py
"""Concrete date/time and related types.

See http://www.iana.org/time-zones/repository/tz-link.html for
time zone and DST data sources.
"""

__all__ = ("date", "datetime", "time", "timedelta", "timezone", "tzinfo",
           "MINYEAR", "MAXYEAR")
...
```

`/usr/lib64/python3.9` contains the modules in [the Python standard library](https://docs.python.org/3/library/).

### Importing your Python files

If you create a file with the `a.py` name:

```
def f():
    return 2
```

, and another with the `b.py` name:

```
import a

print(a.f())
```

, then:

```
$ python b.py
2
```


This works, because `sys.path` contains `''`, which means "the current directory".

(`sys.path` is very similar to the `PATH` variable. However, `sys.path` contains the current directory by default, whereas `PATH` does not.)

When `import a` is executed, then Python searches the directories in `sys.path` for an `a.py` file; it is found when checking the `''` path.
When `import datetime` is executed, Python searches in the current directory (because `''` comes first in the path), doesn't find it, but then finds it in the following `/usr/lib64/python3.9` directory.
Python iterates over the `sys.path` directories, and loads the *first* matching file.