DEV Community: Ademola Babatunde

CRUD On Node FS Module; A Journey Into The World Of File Systems.

Ademola Babatunde — Tue, 05 Oct 2021 13:42:12 +0000

File System in Nodejs

The fs module in nodejs allows you to read, delete, update, and create files on your machine, it gives you access to do anything you want with the files. There are several methods within the module that allows you to do this. Allow me walk you through the process.

^{The cover image was sourced from here}

Must-Haves

Obviously, you must have nodejs installed on your machine. After which you should import the fs module.

const fs = require('fs');

All of the operations of the fs module can be done either synchronously or asynchronously.

The synchronous form blocks the Node.js event loop and further JavaScript execution until the operation is complete. Exceptions are thrown immediately and can be handled using try…catch, or can be allowed to bubble up.
source - nodeJs doc

Creating or Writing Files with the module

fs.writeFile() and fs.writeFileSync() are the asynchronous and synchronous respectively ways of writing to a file if it already exists or creating a new file and writing to it if it does not exist. Examples of both methods are below:
The asynchronous way,

fs.writeFile('newfile.txt', "Hello world", (err) => {
    if (err) return callback(err);
    console.log("file created successfully!")
});

and the synchronous way,

 const file = fs.writeFileSync('newfile.txt', "Hello world");

Reading Files

If we want to read the content of the new file we created above, this can be done using the fs.readFile() and fs.readFileSync() methods. There are various encoding formats to read the file in, the default if not is specified is Buffer. Both functions take the path to the file as the first argument, see the example below:

The asynchronous way,

fs.readFile('newfile.txt', (err, data) => {
    if(err) throw err;
});

The content of the file will be inside the data parameter

The synchronous way,

const data = fs.readFileSync('newfile.txt', "utf8");

Renaming a File

Using the fs.rename()or fs.renameSync() method allows us to rename a file to any new name we want. The method takes in two arguments, the path to the file to be renamed and the second argument is the new name of the file.
See examples below:

The asynchronous way,

fs.rename('newfile.txt',  'renamedfile.txt', (err) => {
    if(err) throw err;
});

The content of the file will be inside the data parameter

The synchronous way,

fs.renameSync('newfile.txt',  'renamedfile.txt');

Deleting a File

To delete a file, we have the fs.unlink() and fs.unlinkSync(). These methods take a single argument, the path to the file to be deleted or removed.

The synchronous way,

fs.unlinkSync('renamedfile.txt');

The asynchronous way,

fs.unlinkSync('renamedfile.txt', (err) =>  {
    if(err) throw err;
};

Conclusion

These are just the basic operations that can be done with the fs module on files, I only talked about files. Operations can be done on directories too and many more. For other features of the fs module, visit the nodejs fs documentation

Snake In The JS Shadow: Run your python script in nodeJs

Ademola Babatunde — Sat, 04 Sep 2021 23:29:54 +0000

^{The cover image was sourced from here}

Ever wondered if you could run a python function inside a nodejs code? I wondered also and I researched and got to see a module in nodejs child_process which allows you to run child processes. You may wonder what child processes are, well according to Wikipedia,

A child process in computing is a process created by another process. This technique pertains to multitasking operating systems and is sometimes called a subprocess or traditionally a subtask. There are two major procedures for creating a child process: the fork system call and the spawn.

I will attempt to walk you through how to run a non-blocking python script inside of your nodejs code.

Must-Haves

Obviously, you must have nodejs installed on your machine. After which you should import the fs module.
Also because I want to display the results in a browser, let's use express to serve it.

npm install express

Set up

Create two files, index.js and main.py, add the code below to your index.js file

const { spawn } = require('child_process');
const express = require("express");
const app = express();

In the main.py file, add the code below

print('Hello')

Main Implementation

In the index.js file, add the following

const pythonPromise = () => {
  return new Promise((resolve, reject) => {
    const python = spawn("python", ["./main.py"]);
    python.stdout.on("data", (data) => {
      resolve(data.toString());
    });

    python.stderr.on("data", (data) => {
      reject(data.toString());
    });
 });
};
app.get("/:name", async (req, res) => {
  const dataFromPython = await pythonPromise();
  res.send(dataFromPython + req.params.name);
});
app.listen(3200, () => console.log("App is running port 3200"));

The spawn function here takes two arguments, the first "python" which is the program we want to run, and "./main" which is the path to the python file we wish to run.
We all know nodejs is event-driven, the two events we are listening for are the python.stdout.on and python.stderr.on. The stderr is short for standard error, which occurs while attempting to run the python script while stdout is short for standard output, which is the return value from our script. The type of data returned is binary, which is why you need to call the toString() method to convert it to a string.

Start your server with node index.js and visit http://localhost:3200/yourName in your browser or postman to see the result.

There will really be no need to use python scripts if we are not passing arguments to the python script, let's edit our main.py to have a function that takes arguments from your nodejs code. Replace with:

import sys
print('Hello ' + sys.argv[1] + ' your id is ' + sys.argv[2])

Also, we add more arguments to the spawn function and our index.js file should look like this below:

const pythonPromise = (data) => {
  return new Promise((resolve, reject) => {
    const python = spawn("python", ["./main.py", ...data]);

    python.stdout.on("data", (data) => {
      resolve(data.toString());
    });

    python.stderr.on("data", (data) => {
      reject(data.toString());
    });
  });
};

app.get("/:name/:id", async (req, res) => {
  const { name, id } = req.params;
  const dataFromPython = await pythonPromise([name, id]);
  res.send(dataFromPython);
});
app.listen(3200, () => console.log("App is running port 3200"));

You may be wondering what the sys module we imported in the main.py script is. According to geeksforgeeks,

The sys module provides functions and variables used to manipulate different parts of the Python runtime environment. This module provides access to some variables used or maintained by the interpreter and to functions that interact strongly with the interpreter.

And the indexes argv[1] and argv[2] are the parameters we wish to pass to the script. The first argument, argr[0] is the name of the file we are running the script from.
Start your server with node index.js and visit http://localhost:3200/yourName/anyId in your browser or postman to see the result.

This is a very basic example to expose you to the powers of the spawn method of the child_process module. There could be complex cases like passing JSON objects to your python script or receiving JSON data from the script, but this should get you started on the path to running python scripts in your nodejs applications. ✌🏻