Class: Overcommit::Hook::PreCommit::Pydocstyle

Inherits:
Base
  • Object
show all
Defined in:
lib/overcommit/hook/pre_commit/pydocstyle.rb

Overview

Runs ‘pydocstyle` against any modified Python files.

See Also:

Instance Attribute Summary

Attributes inherited from Base

#config

Instance Method Summary collapse

Methods inherited from Base

#applicable_files, #command, #description, #enabled?, #execute, #execute_in_background, #flags, #in_path?, #included_files, #initialize, #name, #parallelize?, #processors, #quiet?, #required?, #required_executable, #required_libraries, #run?, #run_and_transform, #skip?

Constructor Details

This class inherits a constructor from Overcommit::Hook::Base

Instance Method Details

#run ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/overcommit/hook/pre_commit/pydocstyle.rb', line 8

def run
  result = execute(command, args: applicable_files)
  return :pass if result.success?

  output = result.stderr.chomp

  # example message:
  #   path/to/file.py:1 in public method `foo`:
  #           D102: Docstring missing
  extract_messages(
    output.gsub(/:\s+/, ': ').split("\n"),
    /^(?<file>(?:\w:)?[^:]+):(?<line>\d+)/
  )
end