Initial support for requirements.{in,txt}

Author: patrick91

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to the "poetry-python" extension will be documented in this
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
+## [0.0.16]
+
+-   Added support for requirements.txt
+
 ## [0.0.15]
 
 -   Initial release with support for pyproject.toml and Poetry

package.json

@@ -16,7 +16,11 @@
     ],
     "activationEvents": [
         "onLanguage:toml",
-        "workspaceContains:pyproject.toml"
+        "onLanguage:txt",
+        "onLanguage:in",
+        "workspaceContains:pyproject.toml",
+        "workspaceContains:requirements.txt",
+        "workspaceContains:requirements.in"
     ],
     "main": "./out/extension.js",
     "scripts": {

src/core/decorations.ts

@@ -7,7 +7,7 @@ export const getDecoration = (dep: Dependency) => {
     message.appendMarkdown(dep.summary || "No information for this library");
     message.isTrusted = true;
 
-    const prefix = dep.version.latest === dep.version.installed ? "✅" : "⚠️";
+    const prefix = dep.version.latest === dep.version.installed ? "✅" : "🚸";
 
     return {
         range: new Range(

src/core/listener.ts

@@ -1,10 +1,11 @@
 import { TextEditor, window, TextEditorDecorationType } from "vscode";
 import { Dependency } from "../types";
-import { findDependencies } from "../utils/parsing";
+import { findDependencies } from "../utils/parsing/toml";
 import { getInstalledVersions } from "./poetry";
 import { getInfo } from "./api";
 import { getDecoration } from "./decorations";
 import { dirname } from "path";
+import { findDependenciesFromRequirementsTxt } from "../utils/parsing/requirements-txt";
 
 let decorationType: TextEditorDecorationType | null = null;
 
@@ -16,21 +17,22 @@ const updateVersions = (
         deps.map(async (dep) => {
             const info = await getInfo(dep.name);
 
-            dep.version.installed = installedVersions[dep.name];
+            // dep.version.installed = installedVersions[dep.name];
             dep.version.latest = info.version;
             dep.summary = info.summary;
         }),
     );
 };
 
-const doThings = async (deps: Dependency[], editor: TextEditor) => {
+const decorateEditor = async (deps: Dependency[], editor: TextEditor) => {
     if (decorationType) {
         decorationType.dispose();
     }
 
-    const installedVersions = await getInstalledVersions(
-        dirname(editor.document.fileName),
-    );
+    const installedVersions = {} 
+    // await getInstalledVersions(
+    //     dirname(editor.document.fileName),
+    // );
 
     await updateVersions(deps, installedVersions);
 
@@ -43,24 +45,40 @@ const doThings = async (deps: Dependency[], editor: TextEditor) => {
     editor.setDecorations(decorationType!, decorations);
 };
 
-function parseAndDecorate(editor: TextEditor) {
+function parseAndDecorateToml(editor: TextEditor) {
     const text = editor.document.getText();
-    // const config = workspace.getConfiguration("", editor.document.uri);
 
     const deps = findDependencies(text);
 
-    console.log("parsing and decorating");
+    decorateEditor(deps, editor);
+}
+
+function parseAndDecorateRequirementsTxt(editor: TextEditor) {
+    const text = editor.document.getText();
+
+    const deps = findDependenciesFromRequirementsTxt(text);
 
-    doThings(deps, editor);
+    decorateEditor(deps, editor);
 }
 
 export const pyProjectListener = (editor: TextEditor | undefined) => {
     if (editor) {
         const { fileName } = editor.document;
         if (fileName.toLocaleLowerCase().endsWith("pyproject.toml")) {
-            parseAndDecorate(editor);
+            parseAndDecorateToml(editor);
+        }
+    }
+};
+
+export const requirementsTxtListener = (editor: TextEditor | undefined) => {
+    if (editor) {
+        const fileName = editor.document.fileName.toLocaleLowerCase();
+
+        if (
+            fileName.endsWith("requirements.txt") ||
+            fileName.endsWith("requirements.in")
+        ) {
+            parseAndDecorateRequirementsTxt(editor);
         }
-    } else {
-        console.log("No active editor found.");
     }
 };

src/extension.ts

@@ -5,28 +5,39 @@ import {
     TextDocumentChangeEvent,
 } from "vscode";
 import { setCache } from "./cache";
-import { pyProjectListener } from "./core/listener";
+import { pyProjectListener, requirementsTxtListener } from "./core/listener";
 
 export function activate(context: ExtensionContext) {
     setCache(context);
 
     context.subscriptions.push(
         window.onDidChangeActiveTextEditor(pyProjectListener),
+        window.onDidChangeActiveTextEditor(requirementsTxtListener),
     );
 
     context.subscriptions.push(
         workspace.onDidChangeTextDocument((e: TextDocumentChangeEvent) => {
-            const { fileName } = e.document;
+            if (e.document.isDirty) {
+                return;
+            }
+
+            const fileName = e.document.fileName.toLocaleLowerCase();
+
+            if (fileName.endsWith("pyproject.toml")) {
+                pyProjectListener(window.activeTextEditor);
+            }
+
             if (
-                !e.document.isDirty &&
-                fileName.toLocaleLowerCase().endsWith("pyproject.toml")
+                fileName.endsWith("requirements.txt") ||
+                fileName.endsWith("requirements.in")
             ) {
-                pyProjectListener(window.activeTextEditor);
+                requirementsTxtListener(window.activeTextEditor);
             }
         }),
     );
 
     pyProjectListener(window.activeTextEditor);
+    requirementsTxtListener(window.activeTextEditor);
 }
 
 export function deactivate() {}

src/utils/parsing/requirements-txt.ts

@@ -0,0 +1,43 @@
+import { Dependency } from "../../types";
+import { splitFirst } from "../strings";
+
+
+const parseDependency = (line: string, lineNumber: number) => {
+    const [name, version] = splitFirst(line, "==").map((x) => x.trim());
+
+    return {
+        name,
+        version: {
+            toml: version,
+        },
+        line: lineNumber,
+        rawText: line,
+    };
+};
+
+export const findDependenciesFromRequirementsTxt = (text: string) => {
+    const lines = text.split("\n");
+
+    const dependencies: Dependency[] = [];
+
+    lines.forEach((line, index) => {
+        line = line.replace(/ #.*$/, "").trim();
+
+        // remove extras like tablib[html]
+        line = line.replace(/\[.*\]/, "");
+
+        if (line === "") {
+            return;
+        }
+
+        if (line.startsWith("#") || line.startsWith("-") || line.startsWith("git+")) {
+            return;
+        } else {
+            const dependency = parseDependency(line, index);
+
+            dependencies.push(dependency);
+        }
+    });
+
+    return dependencies;
+};

src/utils/parsing.ts renamed to src/utils/parsing/toml.ts

@@ -1,5 +1,5 @@
-import { Dependency } from "../types";
-import { splitFirst } from "./strings";
+import { Dependency } from "../../types";
+import { splitFirst } from "../strings";
 
 const parseInfo = (str: string) => {
     // TODO: this is a naive way of parsing this string, but for now it works, probably

src/utils/strings.ts

@@ -1,5 +1,5 @@
-export const splitFirst = (line: string) => {
-    const [a, ...b] = line.split("=");
+export const splitFirst = (line: string, separator: string = '=') => {
+    const [a, ...b] = line.split(separator);
 
     return [a, b.join("=")];
 };