GeezerVison is showing github.com — pre-commit/pre_commit/store.py at main · arshdeepkumar482/pre-commit

Expand file tree

store.py

Copy path

More file actions

Latest commit

History

262 lines (219 loc) · 9.5 KB

store.py

Copy path

File metadata and controls

262 lines (219 loc) · 9.5 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

from __future__ import annotations

import contextlib

import logging

import os.path

import sqlite3

import tempfile

from typing import Callable

from typing import Generator

from typing import Sequence

import pre_commit.constants as C

from pre_commit import file_lock

from pre_commit import git

from pre_commit.util import CalledProcessError

from pre_commit.util import clean_path_on_failure

from pre_commit.util import cmd_output_b

from pre_commit.util import resource_text

from pre_commit.util import rmtree

logger = logging.getLogger('pre_commit')

def _get_default_directory() -> str:

"""Returns the default directory for the Store. This is intentionally

underscored to indicate that `Store.get_default_directory` is the intended

way to get this information. This is also done so

`Store.get_default_directory` can be mocked in tests and

`_get_default_directory` can be tested.

"""

ret = os.environ.get('PRE_COMMIT_HOME') or os.path.join(

os.environ.get('XDG_CACHE_HOME') or os.path.expanduser('~/.cache'),

'pre-commit',

)

return os.path.realpath(ret)

class Store:

get_default_directory = staticmethod(_get_default_directory)

def __init__(self, directory: str | None = None) -> None:

self.directory = directory or Store.get_default_directory()

self.db_path = os.path.join(self.directory, 'db.db')

self.readonly = (

os.path.exists(self.directory) and

not os.access(self.directory, os.W_OK)

)

if not os.path.exists(self.directory):

os.makedirs(self.directory, exist_ok=True)

with open(os.path.join(self.directory, 'README'), 'w') as f:

f.write(

'This directory is maintained by the pre-commit project.\n'

'Learn more: https://github.com/pre-commit/pre-commit\n',

)

if os.path.exists(self.db_path):

return

with self.exclusive_lock():

# Another process may have already completed this work

if os.path.exists(self.db_path): # pragma: no cover (race)

return

# To avoid a race where someone ^Cs between db creation and

# execution of the CREATE TABLE statement

fd, tmpfile = tempfile.mkstemp(dir=self.directory)

# We'll be managing this file ourselves

os.close(fd)

with self.connect(db_path=tmpfile) as db:

db.executescript(

'CREATE TABLE repos ('

' repo TEXT NOT NULL,'

' ref TEXT NOT NULL,'

' path TEXT NOT NULL,'

' PRIMARY KEY (repo, ref)'

');',

)

self._create_config_table(db)

# Atomic file move

os.replace(tmpfile, self.db_path)

@contextlib.contextmanager

def exclusive_lock(self) -> Generator[None, None, None]:

def blocked_cb() -> None: # pragma: no cover (tests are in-process)

logger.info('Locking pre-commit directory')

with file_lock.lock(os.path.join(self.directory, '.lock'), blocked_cb):

yield

@contextlib.contextmanager

def connect(

self,

db_path: str | None = None,

) -> Generator[sqlite3.Connection, None, None]:

db_path = db_path or self.db_path

# sqlite doesn't close its fd with its contextmanager >.<

# contextlib.closing fixes this.

# See: https://stackoverflow.com/a/28032829/812183

with contextlib.closing(sqlite3.connect(db_path)) as db:

# this creates a transaction

with db:

yield db

@classmethod

def db_repo_name(cls, repo: str, deps: Sequence[str]) -> str:

if deps:

return f'{repo}:{",".join(sorted(deps))}'

else:

return repo

def _new_repo(

self,

repo: str,

ref: str,

deps: Sequence[str],

make_strategy: Callable[[str], None],

) -> str:

repo = self.db_repo_name(repo, deps)

def _get_result() -> str | None:

# Check if we already exist

with self.connect() as db:

result = db.execute(

'SELECT path FROM repos WHERE repo = ? AND ref = ?',

(repo, ref),

).fetchone()

return result[0] if result else None

result = _get_result()

if result:

return result

with self.exclusive_lock():

# Another process may have already completed this work

result = _get_result()

if result: # pragma: no cover (race)

return result

logger.info(f'Initializing environment for {repo}.')

directory = tempfile.mkdtemp(prefix='repo', dir=self.directory)

with clean_path_on_failure(directory):

make_strategy(directory)

# Update our db with the created repo

with self.connect() as db:

db.execute(

'INSERT INTO repos (repo, ref, path) VALUES (?, ?, ?)',

[repo, ref, directory],

)

return directory

def _complete_clone(self, ref: str, git_cmd: Callable[..., None]) -> None:

"""Perform a complete clone of a repository and its submodules """

git_cmd('fetch', 'origin', '--tags')

git_cmd('checkout', ref)

git_cmd('submodule', 'update', '--init', '--recursive')

def _shallow_clone(self, ref: str, git_cmd: Callable[..., None]) -> None:

"""Perform a shallow clone of a repository and its submodules """

git_config = 'protocol.version=2'

git_cmd('-c', git_config, 'fetch', 'origin', ref, '--depth=1')

git_cmd('checkout', 'FETCH_HEAD')

git_cmd(

'-c', git_config, 'submodule', 'update', '--init', '--recursive',

'--depth=1',

)

def clone(self, repo: str, ref: str, deps: Sequence[str] = ()) -> str:

"""Clone the given url and checkout the specific ref."""

def clone_strategy(directory: str) -> None:

git.init_repo(directory, repo)

env = git.no_git_env()

def _git_cmd(*args: str) -> None:

cmd_output_b('git', *args, cwd=directory, env=env)

try:

self._shallow_clone(ref, _git_cmd)

except CalledProcessError:

self._complete_clone(ref, _git_cmd)

return self._new_repo(repo, ref, deps, clone_strategy)

LOCAL_RESOURCES = (

'Cargo.toml', 'main.go', 'go.mod', 'main.rs', '.npmignore',

'package.json', 'pre-commit-package-dev-1.rockspec',

'pre_commit_placeholder_package.gemspec', 'setup.py',

'environment.yml', 'Makefile.PL', 'pubspec.yaml',

'renv.lock', 'renv/activate.R', 'renv/LICENSE.renv',

)

def make_local(self, deps: Sequence[str]) -> str:

def make_local_strategy(directory: str) -> None:

for resource in self.LOCAL_RESOURCES:

resource_dirname, resource_basename = os.path.split(resource)

contents = resource_text(f'empty_template_{resource_basename}')

target_dir = os.path.join(directory, resource_dirname)

target_file = os.path.join(target_dir, resource_basename)

os.makedirs(target_dir, exist_ok=True)

with open(target_file, 'w') as f:

f.write(contents)

env = git.no_git_env()

# initialize the git repository so it looks more like cloned repos

def _git_cmd(*args: str) -> None:

cmd_output_b('git', *args, cwd=directory, env=env)

git.init_repo(directory, '<<unknown>>')

_git_cmd('add', '.')

git.commit(repo=directory)

return self._new_repo(

'local', C.LOCAL_REPO_VERSION, deps, make_local_strategy,

)

def _create_config_table(self, db: sqlite3.Connection) -> None:

db.executescript(

'CREATE TABLE IF NOT EXISTS configs ('

' path TEXT NOT NULL,'

' PRIMARY KEY (path)'

');',

)

def mark_config_used(self, path: str) -> None:

if self.readonly: # pragma: win32 no cover

return

path = os.path.realpath(path)

# don't insert config files that do not exist

if not os.path.exists(path):

return

with self.connect() as db:

# TODO: eventually remove this and only create in _create

self._create_config_table(db)

db.execute('INSERT OR IGNORE INTO configs VALUES (?)', (path,))

def select_all_configs(self) -> list[str]:

with self.connect() as db:

self._create_config_table(db)

rows = db.execute('SELECT path FROM configs').fetchall()

return [path for path, in rows]

def delete_configs(self, configs: list[str]) -> None:

with self.connect() as db:

rows = [(path,) for path in configs]

db.executemany('DELETE FROM configs WHERE path = ?', rows)

def select_all_repos(self) -> list[tuple[str, str, str]]:

with self.connect() as db:

return db.execute('SELECT repo, ref, path from repos').fetchall()

def delete_repo(self, db_repo_name: str, ref: str, path: str) -> None:

with self.connect() as db:

db.execute(

'DELETE FROM repos WHERE repo = ? and ref = ?',

(db_repo_name, ref),

)

rmtree(path)