FilesExpand file tree

 fixErrorEvent

/

pvsc-dev-ext.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

153 lines (119 loc) · 4.73 KB

 fixErrorEvent

/

pvsc-dev-ext.py

Copy path

Top

File metadata and controls

• Code
• Blame

153 lines (119 loc) · 4.73 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

#!/usr/bin/env python3

# Copyright (c) Microsoft Corporation. All rights reserved.

# Licensed under the MIT License.

"""Setup and maintain a development build of PVSC.

You must have git, node, and npm installed.

"""

# Downloading the development build of the ``.vsix` was considered, but it actually

# takes longer to install due to the number of files to unzip compared to the

# incremental updates working from a git clone.

import argparse

import enum

import os

import pathlib

import shutil

import subprocess

import sys

REPO_URL = "https://github.com/Microsoft/vscode-python.git"

@enum.unique

class VSCode(enum.Enum):

"""Enum representing the install types of VS Code."""

stable = ".vscode"

insiders = ".vscode-insiders"

def run_command(command, cwd=None):

"""Run the specified command in a subprocess shell."""

executable = shutil.which(command[0])

command[0] = executable

cmd = subprocess.run(command, cwd=cwd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=False)

cmd.check_returncode()

def checkout_directory(install_type, dir_name="vscode-python"):

return pathlib.Path.home() / install_type.value / "extensions" / dir_name

def clone_repo(clone_to, repo, branch):

"""Clone the repository to the appropriate location."""

# https://code.visualstudio.com/docs/editor/extension-gallery#_where-are-extensions-installed

cmd = ["git", "clone", "-q", "--single-branch", "--branch", branch, repo, os.fspath(clone_to)]

run_command(cmd)

def update_checkout(checkout):

"""Update the code the latest version."""

run_command(["git", "pull", "-q", "origin", "master"], cwd=checkout)

def install_npm_dependencies(checkout):

"""Install packages from npm."""

run_command(["npm", "--silent", "--no-progress", "install", "--no-save"], cwd=checkout)

def build_typescript(checkout):

"""Compile all TypeScript code in the extension."""

tsc_path = pathlib.Path("node_modules") / "typescript" / "bin" / "tsc"

run_command(["node", os.fspath(tsc_path), "-p", os.fspath(checkout)], cwd=checkout)

def install_PyPI_packages(checkout):

"""Install packages from PyPI."""

libs_path = checkout / "pythonFiles" / "lib" / "python"

requirements_path = checkout / "requirements.txt"

cmd = [

sys.executable,

"-m",

"pip",

"-q",

"--disable-pip-version-check",

"install",

"--target",

os.fspath(libs_path),

"--no-cache-dir",

"--implementation",

"py",

"--no-deps",

"--upgrade",

"-r",

os.fspath(requirements_path),

]

run_command(cmd)

def cleanup(checkout):

"""Delete files downloaded by the extension."""

for path in checkout.glob("languageServer*"):

if path.is_dir():

shutil.rmtree(path)

def build(checkout):

"""Install dependencies and build the extension."""

print("Installing npm dependencies ...")

install_npm_dependencies(checkout)

print("Building TypeScript files ...")

build_typescript(checkout)

print("Installing PyPI packages ...")

install_PyPI_packages(checkout)

def setup(install_type, repo, branch):

"""Set up a clone of PVSC."""

checkout = checkout_directory(install_type)

print(f"Cloning {repo} ...")

clone_repo(checkout, repo, branch)

build(checkout)

def update():

"""Update development installs of PVSC."""

for install_type in VSCode:

checkout = checkout_directory(install_type)

if not checkout.exists():

continue

print(f"UPDATING {checkout}")

print("Deleting files downloaded by the extension ...")

cleanup(checkout)

print("Updating clone ...")

update_checkout(checkout)

build(checkout)

def parse_args(args=sys.argv[1:]):

"""Parse CLI arguments."""

parser = argparse.ArgumentParser(description="Setup and maintain a development build of PVSC (requires git, node, and npm)")

subparsers = parser.add_subparsers(dest="cmd")

setup_parser = subparsers.add_parser("setup")

setup_parser.add_argument("install_type", choices=[install_type.name for install_type in VSCode])

setup_parser.add_argument('--repo', dest='repo', default=REPO_URL)

setup_parser.add_argument('--branch', dest='branch', default='master')

update_parser = subparsers.add_parser("update")

return parser.parse_args(args)

if __name__ == "__main__":

args = parse_args()

try:

if args.cmd == "setup":

setup(VSCode[args.install_type], args.repo, args.branch)

elif args.cmd == "update":

update()

else:

raise RuntimeError(f"Unrecognized sub-command: {args.cmd!r}")

except subprocess.CalledProcessError as exc:

print(f"Failed to run command {exc.cmd} : {exc.stderr}")