eric: Utilities/__init__.py@927186c0d409 (annotated)

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

555

"""

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

557

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

559

The rest of the line is interpreted as 'key = value'. value is

945

8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 915

diff changeset

561

is assumed to be a string. If a key does not contain a '='

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

563

at the very end of a file. The search is ended, if a line without

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

565

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

567

@return dictionary of string, boolean, complex, float and int

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

569

flags = {}

9d6b6cf31ec6 Fix for SyntaxCheckDialog and eflags evaluation.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 2572

diff changeset

571

lines = text.rstrip().splitlines()

eb5ff61f927b Added a checker for PEP 8 compliance.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 805

diff changeset

573

lines = text

3099

d5dcda74d839 Fix the syntaxcheck if only one file is tested. Fix seldom bug if last line has unicode characters in it.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 3065

diff changeset

575

try:

d5dcda74d839 Fix the syntaxcheck if only one file is tested. Fix seldom bug if last line has unicode characters in it.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 3065

diff changeset

577

except ValueError:

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

579

break

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

581

flag = line[index + 6:].strip()

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

583

key, value = flag.split("=", 1)

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

585

value = value.strip()

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

587

if value.lower() in ["true", "false", "yes", "no", "ok"]:

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

589

flags[key] = value.lower() in ["true", "yes", "ok"]

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

591

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

593

# interpret as int first

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

595

except ValueError:

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

597

# interpret as float next

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

599

except ValueError:

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

601

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

603

else:

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

605

flags[flag] = True

5b1b59777460 Added a feature where flags can be given at the end of a source file. The only flag supported is 'FileType' to overwrite the filetype detection mechanism.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 768

diff changeset

607

return flags

945

8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 915

diff changeset

609

a94b0a2fafd7 Extended the unit test interface to support skipped tests, expected failures and unexpected successes and to better cope with Python2 scripts when run from the eric IDE.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 1142

diff changeset

611

"""

a94b0a2fafd7 Extended the unit test interface to support skipped tests, expected failures and unexpected successes and to better cope with Python2 scripts when run from the eric IDE.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 1142

diff changeset

613

a94b0a2fafd7 Extended the unit test interface to support skipped tests, expected failures and unexpected successes and to better cope with Python2 scripts when run from the eric IDE.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 1142

diff changeset

615

@return dictionary of string, boolean, complex, float and int

a94b0a2fafd7 Extended the unit test interface to support skipped tests, expected failures and unexpected successes and to better cope with Python2 scripts when run from the eric IDE.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 1142

diff changeset

617

try:

a94b0a2fafd7 Extended the unit test interface to support skipped tests, expected failures and unexpected successes and to better cope with Python2 scripts when run from the eric IDE.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 1142

diff changeset

619

except (UnicodeError, IOError):

a94b0a2fafd7 Extended the unit test interface to support skipped tests, expected failures and unexpected successes and to better cope with Python2 scripts when run from the eric IDE.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 1142

diff changeset

621

a94b0a2fafd7 Extended the unit test interface to support skipped tests, expected failures and unexpected successes and to better cope with Python2 scripts when run from the eric IDE.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 1142

diff changeset

623

3173

1fb284abe46e Interface to add user-defined services, e.g. in plugins. Auto syntax check working. Little cleanup.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 3146

diff changeset

625

def extractLineFlags(line, startComment="#", endComment=""):

1fb284abe46e Interface to add user-defined services, e.g. in plugins. Auto syntax check working. Little cleanup.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 3146

diff changeset

627

Function to extract flags starting and ending with '__' from a line

1fb284abe46e Interface to add user-defined services, e.g. in plugins. Auto syntax check working. Little cleanup.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 3146

diff changeset

629

1fb284abe46e Interface to add user-defined services, e.g. in plugins. Auto syntax check working. Little cleanup.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 3146

diff changeset

631

@keyparam startComment string identifying the start of the comment (string)

1fb284abe46e Interface to add user-defined services, e.g. in plugins. Auto syntax check working. Little cleanup.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 3146

diff changeset

633

@return list containing the extracted flags (list of strings)

1fb284abe46e Interface to add user-defined services, e.g. in plugins. Auto syntax check working. Little cleanup.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 3146

diff changeset

635

flags = []

1fb284abe46e Interface to add user-defined services, e.g. in plugins. Auto syntax check working. Little cleanup.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 3146

diff changeset

637

pos = line.rfind(startComment)

1fb284abe46e Interface to add user-defined services, e.g. in plugins. Auto syntax check working. Little cleanup.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 3146

diff changeset

639

comment = line[pos + len(startComment):].strip()

1fb284abe46e Interface to add user-defined services, e.g. in plugins. Auto syntax check working. Little cleanup.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 3146

diff changeset

641

comment = comment.replace("endComment", "")

1fb284abe46e Interface to add user-defined services, e.g. in plugins. Auto syntax check working. Little cleanup.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 3146

diff changeset

643

if (f.startswith("__") and f.endswith("__"))]

1fb284abe46e Interface to add user-defined services, e.g. in plugins. Auto syntax check working. Little cleanup.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 3146

diff changeset

645

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

647

def toNativeSeparators(path):

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

649

Function returning a path, that is using native separator characters.

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

651

@param path path to be converted (string)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

653

"""

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

655

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

657

def fromNativeSeparators(path):

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

659

Function returning a path, that is using "/" separator characters.

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

661

@param path path to be converted (string)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

663

"""

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

665

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

667

def normcasepath(path):

2997

7f0ef975da9e Continued to shorten the code lines to max. 79 characters.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2965

diff changeset

669

Function returning a path, that is normalized with respect to its case

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

671

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

673

@return case normalized path (string)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

675

return os.path.normcase(os.path.normpath(path))

945

8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 915

diff changeset

677

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

679

"""

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

681

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

683

@return absolute, normalized path (string)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

685

return os.path.abspath(path)

945

8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 915

diff changeset

687

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

689

"""

7f0ef975da9e Continued to shorten the code lines to max. 79 characters.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2965

diff changeset

691

its case and references.

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

693

@param path file path (string)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

695

"""

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

697

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

699

def normjoinpath(a, *p):

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

701

Function returning a normalized path of the joined parts passed into it.

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

703

@param a first path to be joined (string)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

705

@return normalized path (string)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

707

return os.path.normpath(os.path.join(a, *p))

945

8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 915

diff changeset

709

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

711

"""

7f0ef975da9e Continued to shorten the code lines to max. 79 characters.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2965

diff changeset

713

into it.

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

715

@param a first path to be joined (string)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

717

@return absolute, normalized path (string)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

719

return os.path.abspath(os.path.join(a, *p))

945

8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 915

diff changeset

721

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

723

"""

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

725

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

727

@param start path to make relative from (string)

d133c7edd88a Continued correcting doc strings by using the new doc string checker.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2770

diff changeset

729

@exception ValueError raised to indicate an invalid path

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

731

if not path:

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

733

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

735

path_list = os.path.abspath(path).split(os.path.sep)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

737

# Work out how much of the filepath is shared by start and path.

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

739

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

741

if not rel_list:

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

743

return os.path.join(*rel_list)

945

8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 915

diff changeset

745

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

747

"""

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

749

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

751

@return flag to indicate, if the executable file is accessible

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

753

"""

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

755

return os.access(file, os.X_OK)

1329

ac21bb9cf8b9 Ammended 'isinpath' and 'getExecutablePath' to check the current directory as well.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 1316

diff changeset

757

if os.path.exists(os.path.join(os.curdir, file)):

ac21bb9cf8b9 Ammended 'isinpath' and 'getExecutablePath' to check the current directory as well.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 1316

diff changeset

759

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

761

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

763

if path is None:

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

765

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

767

for dir in dirs:

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

769

return True

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

771

return False

945

8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 915

diff changeset

773

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

775

"""

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

777

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

779

@return full executable name, if the executable file is accessible

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

781

empty string otherwise.

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

783

if os.path.isabs(file):

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

785

return file

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

787

return ""

1329

ac21bb9cf8b9 Ammended 'isinpath' and 'getExecutablePath' to check the current directory as well.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 1316

diff changeset

789

cur_path = os.path.join(os.curdir, file)

ac21bb9cf8b9 Ammended 'isinpath' and 'getExecutablePath' to check the current directory as well.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 1316

diff changeset

791

if os.access(cur_path, os.X_OK):

1329

ac21bb9cf8b9 Ammended 'isinpath' and 'getExecutablePath' to check the current directory as well.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 1316

diff changeset

793

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

795

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

797

if path is None:

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

799

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

801

for dir in dirs:

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

803

if os.access(exe, os.X_OK):

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

805

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

807

2553

2ef00ee163a8 Added a function to Utilities to determine all possible full executable paths using the PATH environment variable.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2319

diff changeset

809

def getExecutablePaths(file):

2ef00ee163a8 Added a function to Utilities to determine all possible full executable paths using the PATH environment variable.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2319

diff changeset

811

Function to build all full path of an executable file from the environment.

2ef00ee163a8 Added a function to Utilities to determine all possible full executable paths using the PATH environment variable.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2319

diff changeset

813

@param file filename of the executable (string)

7f0ef975da9e Continued to shorten the code lines to max. 79 characters.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2965

diff changeset

815

file is accessible via the searchpath defined by the PATH environment

2553

2ef00ee163a8 Added a function to Utilities to determine all possible full executable paths using the PATH environment variable.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2319

diff changeset

817

"""

2ef00ee163a8 Added a function to Utilities to determine all possible full executable paths using the PATH environment variable.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2319

diff changeset

819

2ef00ee163a8 Added a function to Utilities to determine all possible full executable paths using the PATH environment variable.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2319

diff changeset

821

if os.access(file, os.X_OK):

2ef00ee163a8 Added a function to Utilities to determine all possible full executable paths using the PATH environment variable.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2319

diff changeset

823

else:

2ef00ee163a8 Added a function to Utilities to determine all possible full executable paths using the PATH environment variable.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2319

diff changeset

825

2ef00ee163a8 Added a function to Utilities to determine all possible full executable paths using the PATH environment variable.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2319

diff changeset

827

if os.path.exists(cur_path):

2ef00ee163a8 Added a function to Utilities to determine all possible full executable paths using the PATH environment variable.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2319

diff changeset

829

paths.append(cur_path)

2ef00ee163a8 Added a function to Utilities to determine all possible full executable paths using the PATH environment variable.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2319

diff changeset

831

path = os.getenv('PATH')

2ef00ee163a8 Added a function to Utilities to determine all possible full executable paths using the PATH environment variable.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2319

diff changeset

833

# environment variable not defined

2ef00ee163a8 Added a function to Utilities to determine all possible full executable paths using the PATH environment variable.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2319

diff changeset

835

dirs = path.split(os.pathsep)

2ef00ee163a8 Added a function to Utilities to determine all possible full executable paths using the PATH environment variable.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2319

diff changeset

837

exe = os.path.join(dir, file)

2ef00ee163a8 Added a function to Utilities to determine all possible full executable paths using the PATH environment variable.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2319

diff changeset

839

paths.append(exe)

2ef00ee163a8 Added a function to Utilities to determine all possible full executable paths using the PATH environment variable.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2319

diff changeset

841

return paths

2ef00ee163a8 Added a function to Utilities to determine all possible full executable paths using the PATH environment variable.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2319

diff changeset

843

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

845

"""

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

847

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

849

@return flag indicating executable status (boolean)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

851

return os.access(exe, os.X_OK)

945

8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 915

diff changeset

853

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

855

"""

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

857

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

859

@param f2 second path for the compare (string)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

861

same path on disk.

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

863

if f1 is None or f2 is None:

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

865

7f0ef975da9e Continued to shorten the code lines to max. 79 characters.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2965

diff changeset

867

normcaseabspath(os.path.realpath(f2)):

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

869

2571

e6bb19eb87ea Fixes for autocodecheck with pyflakes and update of py2flakes to 0.6.1.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 2525

diff changeset

871

e6bb19eb87ea Fixes for autocodecheck with pyflakes and update of py2flakes to 0.6.1.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 2525

diff changeset

873

def samefilepath(f1, f2):

e6bb19eb87ea Fixes for autocodecheck with pyflakes and update of py2flakes to 0.6.1.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 2525

diff changeset

875

Function to compare two paths. Strips the filename.

2571

e6bb19eb87ea Fixes for autocodecheck with pyflakes and update of py2flakes to 0.6.1.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 2525

diff changeset

877

@param f1 first filepath for the compare (string)

e6bb19eb87ea Fixes for autocodecheck with pyflakes and update of py2flakes to 0.6.1.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 2525

diff changeset

879

@return flag indicating whether the two paths represent the

e6bb19eb87ea Fixes for autocodecheck with pyflakes and update of py2flakes to 0.6.1.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 2525

diff changeset

881

"""

e6bb19eb87ea Fixes for autocodecheck with pyflakes and update of py2flakes to 0.6.1.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 2525

diff changeset

883

return False

e6bb19eb87ea Fixes for autocodecheck with pyflakes and update of py2flakes to 0.6.1.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 2525

diff changeset

885

if (normcaseabspath(os.path.dirname(os.path.realpath(f1))) ==

070b35dde35e Fixed a bunch of indentation issues.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 3060

diff changeset

887

return True

e6bb19eb87ea Fixes for autocodecheck with pyflakes and update of py2flakes to 0.6.1.

T.Rzepka <Tobias.Rzepka@gmail.com>

parents: 2525

diff changeset

889

return False

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

891

try:

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

893

except AttributeError:

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

895

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

897

def splitPath(name):

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

899

Function to split a pathname into a directory part and a file part.

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

901

@param name path name (string)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

903

"""

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

905

dn = os.path.abspath(name)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

907

else:

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

909

return (dn, fn)

945

8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 915

diff changeset

911

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

913

"""

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

915

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

917

separator if necessary.

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

919

@param prefix the basepart of the filename (string)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

921

@return the complete filename (string)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

923

if ext[0] != ".":

7f0ef975da9e Continued to shorten the code lines to max. 79 characters.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2965

diff changeset

925

# os.path.splitext

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

927

8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 915

diff changeset

929

def compactPath(path, width, measure=len):

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

931

Function to return a compacted path fitting inside the given width.

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

933

@param path path to be compacted (string)

2997

7f0ef975da9e Continued to shorten the code lines to max. 79 characters.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2965

diff changeset

935

@param measure reference to a function used to measure the length of the

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

937

@return compacted path (string)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

939

if measure(path) <= width:

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

941

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

943

343

f23d1272de6b Changed algorithm for compactPath() slightly.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 177

diff changeset

945

mid = len(head) // 2

f23d1272de6b Changed algorithm for compactPath() slightly.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 177

diff changeset

947

head2 = head[mid:]

f23d1272de6b Changed algorithm for compactPath() slightly.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 177

diff changeset

949

# head1 is same size as head2 or one shorter

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

951

if measure(path) <= width:

343

f23d1272de6b Changed algorithm for compactPath() slightly.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 177

diff changeset

953

head1 = head1[:-1]

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

955

path = os.path.join(ellipsis, tail)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

957

return path

432

497e188ee86e Did some more string format conversions.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 381

diff changeset

959

path = "{0}{1}".format(ellipsis, tail)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

961

return path

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

963

return ""

945

8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 915

diff changeset

965

7f0ef975da9e Continued to shorten the code lines to max. 79 characters.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2965

diff changeset

967

checkStop=None):

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

969

Function returning a list of all files and directories.

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

971

@param path root of the tree to check

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

973

@param pattern a filename pattern to check against

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

975

should be followed

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

977

@return list of all files and directories in the tree rooted

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

979

"""

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

981

files = []

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

983

files = [path]

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

985

entries = os.listdir(path)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

987

if checkStop and checkStop():

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

989

8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 915

diff changeset

991

'.svn', '_svn',

177

c822ccc4d138 Added some code to tune performance.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 159

diff changeset

993

'.ropeproject', '_ropeproject',

177

c822ccc4d138 Added some code to tune performance.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 159

diff changeset

995

'.issues', '_issues']:

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

997

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

999

if pattern and \

8dd0165d805d Fixed a bunch of indentation issues.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 3030

diff changeset

1001

not fnmatch.fnmatch(entry, pattern):

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1003

continue

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1005

if os.path.isdir(fentry):

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1007

continue

7f0ef975da9e Continued to shorten the code lines to max. 79 characters.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2965

diff changeset

1009

fentry, filesonly, pattern, followsymlinks, checkStop)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1011

files.append(fentry)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1013

pass

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1015

pass

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1017

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1019

def getDirs(path, excludeDirs):

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1021

Function returning a list of all directories below path.

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1023

@param path root of the tree to check

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1025

@return list of all directories found

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1027

try:

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1029

except EnvironmentError:

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1031

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1033

for name in names:

3039

8dd0165d805d Fixed a bunch of indentation issues.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 3030

diff changeset

1035

not os.path.islink(os.path.join(path, name)):

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1037

for e in excludeDirs:

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1039

exclude = 1

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1041

if not exclude:

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1043

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1045

if not os.path.islink(name):

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1047

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1049

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1051

def getTestFileName(fn):

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1053

Function to build the filename of a unittest file.

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1055

The filename for the unittest file is built by prepending

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1057

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1059

@return filename of the corresponding unittest file (string)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1061

dn, fn = os.path.split(fn)

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1063

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1065

def parseOptionString(s):

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1067

Function used to convert an option string into a list of options.

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1069

@param s option string (string or string)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1071

"""

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1073

s = re.sub(r"%[A-Z%]", _percentReplacementFunc, s)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1075

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1077

def parseEnvironmentString(s):

2997

7f0ef975da9e Continued to shorten the code lines to max. 79 characters.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 2965

diff changeset

1079

Function used to convert an environment string into a list of environment

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1081

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1083

@return list of environment settings (list of strings)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1085

rx = QRegExp(r"""\s(\w+\+?=[^\s]+|\w+="[^"]+"|\w+='[^']+')""")

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1087

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1089

def parseString(s, rx):

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1091

Function used to convert a string into a list.

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1093

@param s string to be parsed (string)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1095

@return list of parsed data (list of strings)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1097

olist = []

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1099

# prepare the string to fit our pattern

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1101

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1103

while pos != -1:

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1105

if cs.startswith('"') or cs.startswith("'"):

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1107

olist.append(cs)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1109

pos = rx.indexIn(s, pos)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1111

return olist

945

8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 915

diff changeset

1113

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1115

"""

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1117

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1119

@return replacement string

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1121

return getPercentReplacement(matchobj.group(0))

945

8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 915

diff changeset

1123

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1125

"""

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1127

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1129

@return replacement string (string)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1131

if code in ["C", "%C"]:

53

c3eb7cc1ff8b Renamed e5App to e5App.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 46

diff changeset

1133

aw = e5App().getObject("ViewManager").activeWindow()

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1135

column = -1

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1137

column = aw.getCursorPosition()[1]

0

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1139

elif code in ["D", "%D"]:

53

c3eb7cc1ff8b Renamed e5App to e5App.

Detlev Offenbach <detlev@die-offenbachs.de>

parents: 46

diff changeset

1141

aw = e5App().getObject("ViewManager").activeWindow()

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1143

dn = "not_available"

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1145

fn = aw.getFileName()

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1147

dn = "not_available"

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1149

dn = os.path.dirname(fn)

de9c2efb9d02 Started porting eric4 to Python3

Detlev Offenbach <detlev@die-offenbachs.de>

parents:

diff changeset

1151

elif code in ["F", "%F&

Mercurial Repositories > eric / annotate

Utilities/init.py@927186c0d409 (annotated)

Utilities/init.py

 # -*- coding: utf-8 -*-
 # Copyright (c) 2003 - 2014 Detlev Offenbach <detlev@die-offenbachs.de>
 #
 """
 Package implementing various functions/classes needed everywhere within eric5.
 """
 from __future__ import unicode_literals
 try:
     str = unicode   # __IGNORE_WARNING__
     import urllib
     def quote(url):
         """
         Replacement for the urllib.quote function because of unicode problems.
         @param url text to quote (string)
         @return quoted url (string)
         """
         return urllib.quote(url.encode('utf-8'))
 except (NameError):
     basestring = str
     from urllib.parse import quote    # __IGNORE_WARNING__
 import os
 import sys
 import codecs
 import re
 import fnmatch
 import glob
 import getpass
 def __showwarning(message, category, filename, lineno, file=None, line=""):
     """
     Module function to raise a SyntaxError for a SyntaxWarning.
     @param message warning object
     @param category type object of the warning
     @param filename name of the file causing the warning (string)
     @param lineno line number causing the warning (integer)
     @param file file to write the warning message to (ignored)
     @param line line causing the warning (ignored)
     @raise SyntaxError
     """
     if category is SyntaxWarning:
         err = SyntaxError(str(message))
         err.filename = filename
         err.lineno = lineno
         raise err
 import warnings
 warnings.showwarning = __showwarning
 from codecs import BOM_UTF8, BOM_UTF16, BOM_UTF32
 from PyQt4.QtCore import QRegExp, QDir, QProcess, Qt, QByteArray, \
     qVersion, PYQT_VERSION_STR, QCoreApplication, QCryptographicHash
 from PyQt4.Qsci import QSCINTILLA_VERSION_STR, QsciScintilla
 # import these methods into the Utilities namespace
 from Globals import (  # __IGNORE_WARNING__
     isWindowsPlatform, isLinuxPlatform, isMacPlatform, getConfigDir,
     setConfigDir, getPythonModulesDirectory, getPyQt4ModulesDirectory,
     getQtBinariesPath)
 from E5Gui.E5Application import e5App
 from UI.Info import Program, Version
 import Preferences
 from Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheck import normalizeCode
 from eric5config import getConfig
 configDir = None
 codingBytes_regexps = [
     (2, re.compile(br'''coding[:=]\s*([-\w_.]+)''')),
     (1, re.compile(br'''<\?xml.*\bencoding\s*=\s*['"]([-\w_.]+)['"]\?>''')),
 ]
 coding_regexps = [
     (2, re.compile(r'''coding[:=]\s*([-\w_.]+)''')),
     (1, re.compile(r'''<\?xml.*\bencoding\s*=\s*['"]([-\w_.]+)['"]\?>''')),
 ]
 supportedCodecs = [
     'utf-8',
     'iso8859-1', 'iso8859-15', 'iso8859-2', 'iso8859-3',
     'iso8859-4', 'iso8859-5', 'iso8859-6', 'iso8859-7',
     'iso8859-8', 'iso8859-9', 'iso8859-10', 'iso8859-11',
     'iso8859-13', 'iso8859-14', 'iso8859-16', 'latin-1',
     'koi8-r', 'koi8-u',
     'utf-16', 'utf-32',
     'cp037', 'cp424', 'cp437', 'cp500', 'cp737', 'cp775',
     'cp850', 'cp852', 'cp855', 'cp856', 'cp857', 'cp860',
     'cp861', 'cp862', 'cp863', 'cp864', 'cp865', 'cp866',
     'cp869', 'cp874', 'cp875', 'cp932', 'cp949', 'cp950',
     'cp1006', 'cp1026', 'cp1140', 'cp1250', 'cp1251',
     'cp1252', 'cp1253', 'cp1254', 'cp1255', 'cp1256',
     'cp1257', 'cp1258',
     'gb2312', 'gb18030',
     'ascii'
 ]
 class CodingError(Exception):
     """
     Class implementing an exception, which is raised, if a given coding is
     incorrect.
     """
     def __init__(self, coding):
         """
         Constructor
         @param coding coding to include in the message (string)
         """
         self.errorMessage = QCoreApplication.translate(
             "CodingError",
             "The coding '{0}' is wrong for the given text.").format(coding)
     def __repr__(self):
         """
         Private method returning a representation of the exception.
         @return string representing the error message
         """
         return str(self.errorMessage)
     def __str__(self):
         """
         Private method returning a string representation of the exception.
         @return string representing the error message
         """
         return str(self.errorMessage)
 def get_codingBytes(text):
     """
     Function to get the coding of a bytes text.
     @param text bytes text to inspect (bytes)
     @return coding string
     """
     lines = text.splitlines()
     for coding in codingBytes_regexps:
         coding_re = coding[1]
         head = lines[:coding[0]]
         for l in head:
             m = coding_re.search(l)
             if m:
                 return str(m.group(1), "ascii").lower()
     return None
 def get_coding(text):
     """
     Function to get the coding of a text.
     @param text text to inspect (string)
     @return coding string
     """
     lines = text.splitlines()
     for coding in coding_regexps:
         coding_re = coding[1]
         head = lines[:coding[0]]
         for l in head:
             m = coding_re.search(l)
             if m:
                 return m.group(1).lower()
     return None
 def readEncodedFile(filename):
     """
     Function to read a file and decode its contents into proper text.
     @param filename name of the file to read (string)
     @return tuple of decoded text and encoding (string, string)
     """
     f = open(filename, "rb")
     text = f.read()
     f.close()
     return decode(text)
 def readEncodedFileWithHash(filename):
     """
     Function to read a file, calculate a hash value and decode its contents
     into proper text.
     @param filename name of the file to read (string)
     @return tuple of decoded text, encoding and hash value (string, string,
         string)
     """
     f = open(filename, "rb")
     text = f.read()
     f.close()
     hash = str(QCryptographicHash.hash(
                QByteArray(text), QCryptographicHash.Md5).toHex(),
                encoding="ASCII")
     return decode(text) + (hash, )
 def decode(text):
     """
     Function to decode some byte text into a string.
     @param text byte text to decode (bytes)
     @return tuple of decoded text and encoding (string, string)
     """
     try:
         if text.startswith(BOM_UTF8):
             # UTF-8 with BOM
             return str(text[len(BOM_UTF8):], 'utf-8'), 'utf-8-bom'
         elif text.startswith(BOM_UTF16):
             # UTF-16 with BOM
             return str(text[len(BOM_UTF16):], 'utf-16'), 'utf-16'
         elif text.startswith(BOM_UTF32):
             # UTF-32 with BOM
             return str(text[len(BOM_UTF32):], 'utf-32'), 'utf-32'
         coding = get_codingBytes(text)
         if coding:
             return str(text, coding), coding
     except (UnicodeError, LookupError):
         pass
     # Assume UTF-8
     try:
         return str(text, 'utf-8'), 'utf-8-guessed'
     except (UnicodeError, LookupError):
         pass
     guess = None
     if Preferences.getEditor("AdvancedEncodingDetection"):
         # Try the universal character encoding detector
         try:
             import ThirdParty.CharDet.chardet
             guess = ThirdParty.CharDet.chardet.detect(text)
             if guess and guess['confidence'] > 0.95 and \
                     guess['encoding'] is not None:
                 codec = guess['encoding'].lower()
                 return str(text, codec), '{0}-guessed'.format(codec)
         except (UnicodeError, LookupError):
             pass
         except ImportError:
             pass
     # Try default encoding
     try:
         codec = Preferences.getEditor("DefaultEncoding")
         return str(text, codec), '{0}-default'.format(codec)
     except (UnicodeError, LookupError):
         pass
     if Preferences.getEditor("AdvancedEncodingDetection"):
         # Use the guessed one even if confifence level is low
         if guess and guess['encoding'] is not None:
             try:
                 codec = guess['encoding'].lower()
                 return str(text, codec), '{0}-guessed'.format(codec)
             except (UnicodeError, LookupError):
                 pass
     # Assume UTF-8 loosing information
     return str(text, "utf-8", "ignore"), 'utf-8-ignore'
 def writeEncodedFile(filename, text, orig_coding):
     """
     Function to write a file with properly encoded text.
     @param filename name of the file to read (string)
     @param text text to be written (string)
     @param orig_coding type of the original encoding (string)
     @return encoding used for writing the file (string)
     """
     etext, encoding = encode(text, orig_coding)
     f = open(filename, "wb")
     f.write(etext)
     f.close()
     return encoding
 def encode(text, orig_coding):
     """
     Function to encode text into a byte text.
     @param text text to be encoded (string)
     @param orig_coding type of the original encoding (string)
     @return tuple of encoded text and encoding used (bytes, string)
     @exception CodingError raised to indicate an invalid encoding
     """
     encoding = None
     if orig_coding == 'utf-8-bom':
         etext, encoding = BOM_UTF8 + text.encode("utf-8"), 'utf-8-bom'
     else:
         # Try declared coding spec
         coding = get_coding(text)
         if coding:
             try:
                 etext, encoding = text.encode(coding), coding
             except (UnicodeError, LookupError):
                 # Error: Declared encoding is incorrect
                 raise CodingError(coding)
         else:
             if orig_coding and orig_coding.endswith(
                     ('-selected', '-default', '-guessed', '-ignore')):
                 coding = orig_coding\
                     .replace("-selected", "")\
                     .replace("-default", "")\
                     .replace("-guessed", "")\
                     .replace("-ignore", "")
                 try:
                     etext, encoding = text.encode(coding), coding
                 except (UnicodeError, LookupError):
                     pass
             if encoding is None:
                 # Try configured default
                 try:
                     codec = Preferences.getEditor("DefaultEncoding")
                     etext, encoding = text.encode(codec), codec
                 except (UnicodeError, LookupError):
                     pass
                 if encoding is None:
                     # Try saving as ASCII
                     try:
                         etext, encoding = text.encode('ascii'), 'ascii'
                     except UnicodeError:
                         pass
                     if encoding is None:
                         # Save as UTF-8 without BOM
                         etext, encoding = text.encode('utf-8'), 'utf-8'
     return etext, encoding
 def decodeString(text):
     """
     Function to decode a string containing Unicode encoded characters.
     @param text text containing encoded chars (string)
     @return decoded text (string)
     """
     buf = b""
     index = 0
     while index < len(text):
         if text[index] == "\\":
             qb = QByteArray.fromHex(text[index:index + 4])
             buf += bytes(qb)
             index += 4
         else:
             buf += codecs.encode(text[index], "utf-8")
             index += 1
     buf = buf.replace(b"\x00", b"")
     return decodeBytes(buf)
 def decodeBytes(buffer):
     """
     Function to decode some byte text into a string.
     @param buffer byte buffer to decode (bytes)
     @return decoded text (string)
     """
     # try UTF with BOM
     try:
         if buffer.startswith(BOM_UTF8):
             # UTF-8 with BOM
             return str(buffer[len(BOM_UTF8):], encoding='utf-8')
         elif buffer.startswith(BOM_UTF16):
             # UTF-16 with BOM
             return str(buffer[len(BOM_UTF16):], encoding='utf-16')
         elif buffer.startswith(BOM_UTF32):
             # UTF-32 with BOM
             return str(buffer[len(BOM_UTF32):], encoding='utf-32')
     except (UnicodeError, LookupError):
         pass
     # try UTF-8
     try:
         return str(buffer, encoding="utf-8")
     except UnicodeError:
         pass
     # try codec detection
     try:
         import ThirdParty.CharDet.chardet
         guess = ThirdParty.CharDet.chardet.detect(buffer)
         if guess and guess['encoding'] is not None:
             codec = guess['encoding'].lower()
             return str(buffer, encoding=codec)
     except (UnicodeError, LookupError):
         pass
     except ImportError:
         pass
     return str(buffer, encoding="utf-8", errors="ignore")
 def readStringFromStream(stream):
     """
     Module function to read a string from the given stream.
     @param stream data stream opened for reading (QDataStream)
     @return string read from the stream (string)
     """
     data = stream.readString()
     if data is None:
         data = b""
     return data.decode('utf-8')
 _escape = re.compile("[&<>\"'\u0080-\uffff]")
 _escape_map = {
     "&": "&amp;",
     "<": "&lt;",
     ">": "&gt;",
     '"': "&quot;",
     "'": "&#x27;",
 }
 def escape_entities(m, map=_escape_map):
     """
     Function to encode html entities.
     @param m the match object
     @param map the map of entities to encode
     @return the converted text (string)
     """
     char = m.group()
     text = map.get(char)
     if text is None:
         text = "&#{0:d};".format(ord(char))
     return text
 def html_encode(text, pattern=_escape):
     """
     Function to correctly encode a text for html.
     @param text text to be encoded (string)
     @param pattern search pattern for text to be encoded (string)
     @return the encoded text (string)
     """
     if not text:
         return ""
     text = pattern.sub(escape_entities, text)
     return text
 _uescape = re.compile('[\u0080-\uffff]')
 def escape_uentities(m):
     """
     Function to encode html entities.
     @param m the match object
     @return the converted text (string)
     """
     char = m.group()
     text = "&#{0:d};".format(ord(char))
     return text
 def html_uencode(text, pattern=_uescape):
     """
     Function to correctly encode a unicode text for html.
     @param text text to be encoded (string)
     @param pattern search pattern for text to be encoded (string)
     @return the encoded text (string)
     """
     if not text:
         return ""
     text = pattern.sub(escape_uentities, text)
     return text
 _uunescape = re.compile('&#\d+;')
 def unescape_uentities(m):
     """
     Function to decode html entities.
     @param m the match object
     @return the converted text (string)
     """
     char = m.group()
     ord = int(char[2:-1])
     return chr(ord)
 def html_udecode(text, pattern=_uunescape):
     """
     Function to correctly decode a html text to a unicode text.
     @param text text to be decoded (string)
     @param pattern search pattern for text to be decoded (string)
     @return the decoded text (string)
     """
     if not text:
         return ""
     text = pattern.sub(unescape_uentities, text)
     return text
 def convertLineEnds(text, eol):
     """
     Function to convert the end of line characters.
     @param text text to be converted (string)
     @param eol new eol setting (string)
     @return text with converted eols (string)
     """
     if eol == '\r\n':
         regexp = re.compile(r"""(\r(?!\n)|(?<!\r)\n)""")
         return regexp.sub(lambda m, eol='\r\n': eol, text)
     elif eol == '\n':
         regexp = re.compile(r"""(\r\n|\r)""")
         return regexp.sub(lambda m, eol='\n': eol, text)
     elif eol == '\r':
         regexp = re.compile(r"""(\r\n|\n)""")
         return regexp.sub(lambda m, eol='\r': eol, text)
     else:
         return text
 def linesep():
     """
     Function to return the lineseparator used by the editor.
     @return line separator used by the editor (string)
     """
     eolMode = Preferences.getEditor("EOLMode")
     if eolMode == QsciScintilla.EolUnix:
         return "\n"
     elif eolMode == QsciScintilla.EolMac:
         return "\r"
     else:
         return "\r\n"
 def extractFlags(text):
     """
     Function to extract eric specific flags out of the given text.
     Flags are contained in comments and are introduced by 'eflag:'.
     The rest of the line is interpreted as 'key = value'. value is
     analyzed for being an integer or float value. If that fails, it
     is assumed to be a string. If a key does not contain a '='
     character, it is assumed to be a boolean flag. Flags are expected
     at the very end of a file. The search is ended, if a line without
     the 'eflag:' marker is found.
     @param text text to be scanned (string)
     @return dictionary of string, boolean, complex, float and int
     """
     flags = {}
     if isinstance(text, basestring):
         lines = text.rstrip().splitlines()
     else:
         lines = text
     for line in reversed(lines):
         try:
             index = line.index("eflag:")
         except ValueError:
             # no flag found, don't look any further
             break
         flag = line[index + 6:].strip()
         if "=" in flag:
             key, value = flag.split("=", 1)
             key = key.strip()
             value = value.strip()
             if value.lower() in ["true", "false", "yes", "no", "ok"]:
                 # it is a flag
                 flags[key] = value.lower() in ["true", "yes", "ok"]
                 continue
             try:
                 # interpret as int first
                 value = int(value)
             except ValueError:
                 try:
                     # interpret as float next
                     value = float(value)
                 except ValueError:
                     pass
             flags[key] = value
         else:
             # treat it as a boolean
             flags[flag] = True
     return flags
 def extractFlagsFromFile(filename):
     """
     Function to extract eric specific flags out of the given file.
     @param filename name of the file to be scanned (string)
     @return dictionary of string, boolean, complex, float and int
     """
     try:
         source, encoding = readEncodedFile(filename)
     except (UnicodeError, IOError):
         return {}
     return extractFlags(source)
 def extractLineFlags(line, startComment="#", endComment=""):
     """
     Function to extract flags starting and ending with '__' from a line
     comment.
     @param line line to extract flags from (string)
     @keyparam startComment string identifying the start of the comment (string)
     @keyparam endComment string identifying the end of a comment (string)
     @return list containing the extracted flags (list of strings)
     """
     flags = []
     pos = line.rfind(startComment)
     if pos >= 0:
         comment = line[pos + len(startComment):].strip()
         if endComment:
             comment = comment.replace("endComment", "")
         flags = [f.strip() for f in comment.split()
                  if (f.startswith("__") and f.endswith("__"))]
     return flags
 def toNativeSeparators(path):
     """
     Function returning a path, that is using native separator characters.
     @param path path to be converted (string)
     @return path with converted separator characters (string)
     """
     return QDir.toNativeSeparators(path)
 def fromNativeSeparators(path):
     """
     Function returning a path, that is using "/" separator characters.
     @param path path to be converted (string)
     @return path with converted separator characters (string)
     """
     return QDir.fromNativeSeparators(path)
 def normcasepath(path):
     """
     Function returning a path, that is normalized with respect to its case
     and references.
     @param path file path (string)
     @return case normalized path (string)
     """
     return os.path.normcase(os.path.normpath(path))
 def normabspath(path):
     """
     Function returning a normalized, absolute path.
     @param path file path (string)
     @return absolute, normalized path (string)
     """
     return os.path.abspath(path)
 def normcaseabspath(path):
     """
     Function returning an absolute path, that is normalized with respect to
     its case and references.
     @param path file path (string)
     @return absolute, normalized path (string)
     """
     return os.path.normcase(os.path.abspath(path))
 def normjoinpath(a, *p):
     """
     Function returning a normalized path of the joined parts passed into it.
     @param a first path to be joined (string)
     @param p variable number of path parts to be joind (string)
     @return normalized path (string)
     """
     return os.path.normpath(os.path.join(a, *p))
 def normabsjoinpath(a, *p):
     """
     Function returning a normalized, absolute path of the joined parts passed
     into it.
     @param a first path to be joined (string)
     @param p variable number of path parts to be joind (string)
     @return absolute, normalized path (string)
     """
     return os.path.abspath(os.path.join(a, *p))
 def relpath(path, start=os.path.curdir):
     """
     Return a relative version of a path.
     @param path path to make relative (string)
     @param start path to make relative from (string)
     @return relative path (string)
     @exception ValueError raised to indicate an invalid path
     """
     if not path:
         raise ValueError("no path specified")
     start_list = os.path.abspath(start).split(os.path.sep)
     path_list = os.path.abspath(path).split(os.path.sep)
     # Work out how much of the filepath is shared by start and path.
     i = len(os.path.commonprefix([start_list, path_list]))
     rel_list = [os.path.pardir] * (len(start_list) - i) + path_list[i:]
     if not rel_list:
         return os.path.curdir
     return os.path.join(*rel_list)
 def isinpath(file):
     """
     Function to check for an executable file.
     @param file filename of the executable to check (string)
     @return flag to indicate, if the executable file is accessible
         via the searchpath defined by the PATH environment variable.
     """
     if os.path.isabs(file):
         return os.access(file, os.X_OK)
     if os.path.exists(os.path.join(os.curdir, file)):
         return os.access(os.path.join(os.curdir, file), os.X_OK)
     path = getEnvironmentEntry('PATH')
     # environment variable not defined
     if path is None:
         return False
     dirs = path.split(os.pathsep)
     for dir in dirs:
         if os.access(os.path.join(dir, file), os.X_OK):
             return True
     return False
 def getExecutablePath(file):
     """
     Function to build the full path of an executable file from the environment.
     @param file filename of the executable to check (string)
     @return full executable name, if the executable file is accessible
         via the searchpath defined by the PATH environment variable, or an
         empty string otherwise.
     """
     if os.path.isabs(file):
         if os.access(file, os.X_OK):
             return file
         else:
             return ""
     cur_path = os.path.join(os.curdir, file)
     if os.path.exists(cur_path):
         if os.access(cur_path, os.X_OK):
             return cur_path
     path = os.getenv('PATH')
     # environment variable not defined
     if path is None:
         return ""
     dirs = path.split(os.pathsep)
     for dir in dirs:
         exe = os.path.join(dir, file)
         if os.access(exe, os.X_OK):
             return exe
     return ""
 def getExecutablePaths(file):
     """
     Function to build all full path of an executable file from the environment.
     @param file filename of the executable (string)
     @return list of full executable names (list of strings), if the executable
         file is accessible via the searchpath defined by the PATH environment
         variable, or an empty list otherwise.
     """
     paths = []
     if os.path.isabs(file):
         if os.access(file, os.X_OK):
             return [file]
         else:
             return []
     cur_path = os.path.join(os.curdir, file)
     if os.path.exists(cur_path):
         if os.access(cur_path, os.X_OK):
             paths.append(cur_path)
     path = os.getenv('PATH')
     # environment variable not defined
     if path is not None:
         dirs = path.split(os.pathsep)
         for dir in dirs:
             exe = os.path.join(dir, file)
             if os.access(exe, os.X_OK) and exe not in paths:
                 paths.append(exe)
     return paths
 def isExecutable(exe):
     """
     Function to check, if a file is executable.
     @param exe filename of the executable to check (string)
     @return flag indicating executable status (boolean)
     """
     return os.access(exe, os.X_OK)
 def samepath(f1, f2):
     """
     Function to compare two paths.
     @param f1 first path for the compare (string)
     @param f2 second path for the compare (string)
     @return flag indicating whether the two paths represent the
         same path on disk.
     """
     if f1 is None or f2 is None:
         return False
     if normcaseabspath(os.path.realpath(f1)) == \
             normcaseabspath(os.path.realpath(f2)):
         return True
     return False
 def samefilepath(f1, f2):
     """
     Function to compare two paths. Strips the filename.
     @param f1 first filepath for the compare (string)
     @param f2 second filepath for the compare (string)
     @return flag indicating whether the two paths represent the
         same path on disk.
     """
     if f1 is None or f2 is None:
         return False
     if (normcaseabspath(os.path.dirname(os.path.realpath(f1))) ==
             normcaseabspath(os.path.dirname(os.path.realpath(f2)))):
         return True
     return False
 try:
     EXTSEP = os.extsep
 except AttributeError:
     EXTSEP = "."
 def splitPath(name):
     """
     Function to split a pathname into a directory part and a file part.
     @param name path name (string)
     @return a tuple of 2 strings (dirname, filename).
     """
     if os.path.isdir(name):
         dn = os.path.abspath(name)
         fn = "."
     else:
         dn, fn = os.path.split(name)
     return (dn, fn)
 def joinext(prefix, ext):
     """
     Function to join a file extension to a path.
     The leading "." of ext is replaced by a platform specific extension
     separator if necessary.
     @param prefix the basepart of the filename (string)
     @param ext the extension part (string)
     @return the complete filename (string)
     """
     if ext[0] != ".":
         ext = ".{0}".format(ext)  # require leading separator to match
                                   # os.path.splitext
     return prefix + EXTSEP + ext[1:]
 def compactPath(path, width, measure=len):
     """
     Function to return a compacted path fitting inside the given width.
     @param path path to be compacted (string)
     @param width width for the compacted path (integer)
     @param measure reference to a function used to measure the length of the
         string
     @return compacted path (string)
     """
     if measure(path) <= width:
         return path
     ellipsis = '...'
     head, tail = os.path.split(path)
     mid = len(head) // 2
     head1 = head[:mid]
     head2 = head[mid:]
     while head1:
         # head1 is same size as head2 or one shorter
         path = os.path.join("{0}{1}{2}".format(head1, ellipsis, head2), tail)
         if measure(path) <= width:
             return path
         head1 = head1[:-1]
         head2 = head2[1:]
     path = os.path.join(ellipsis, tail)
     if measure(path) <= width:
         return path
     while tail:
         path = "{0}{1}".format(ellipsis, tail)
         if measure(path) <= width:
             return path
         tail = tail[1:]
     return ""
 def direntries(path, filesonly=False, pattern=None, followsymlinks=True,
                checkStop=None):
     """
     Function returning a list of all files and directories.
     @param path root of the tree to check
     @param filesonly flag indicating that only files are wanted
     @param pattern a filename pattern to check against
     @param followsymlinks flag indicating whether symbolic links
             should be followed
     @param checkStop function to be called to check for a stop
     @return list of all files and directories in the tree rooted
         at path. The names are expanded to start with path.
     """
     if filesonly:
         files = []
     else:
         files = [path]
     try:
         entries = os.listdir(path)
         for entry in entries:
             if checkStop and checkStop():
                 break
             if entry in ['CVS', 'cvs',
                          '.svn', '_svn',
                          '.hg', '_hg',
                          '.ropeproject', '_ropeproject',
                          '.eric5project', '_eric5project',
                          '.issues', '_issues']:
                 continue
             fentry = os.path.join(path, entry)
             if pattern and \
                 not os.path.isdir(fentry) and \
                     not fnmatch.fnmatch(entry, pattern):
                 # entry doesn't fit the given pattern
                 continue
             if os.path.isdir(fentry):
                 if os.path.islink(fentry) and not followsymlinks:
                     continue
                 files += direntries(
                     fentry, filesonly, pattern, followsymlinks, checkStop)
             else:
                 files.append(fentry)
     except OSError:
         pass
     except UnicodeDecodeError:
         pass
     return files
 def getDirs(path, excludeDirs):
     """
     Function returning a list of all directories below path.
     @param path root of the tree to check
     @param excludeDirs basename of directories to ignore
     @return list of all directories found
     """
     try:
         names = os.listdir(path)
     except EnvironmentError:
         return
     dirs = []
     for name in names:
         if os.path.isdir(os.path.join(path, name)) and \
                 not os.path.islink(os.path.join(path, name)):
             exclude = 0
             for e in excludeDirs:
                 if name.split(os.sep, 1)[0] == e:
                     exclude = 1
                     break
             if not exclude:
                 dirs.append(os.path.join(path, name))
     for name in dirs[:]:
         if not os.path.islink(name):
             dirs = dirs + getDirs(name, excludeDirs)
     return dirs
 def getTestFileName(fn):
     """
     Function to build the filename of a unittest file.
     The filename for the unittest file is built by prepending
     the string "test" to the filename passed into this function.
     @param fn filename basis to be used for the unittest filename (string)
     @return filename of the corresponding unittest file (string)
     """
     dn, fn = os.path.split(fn)
     return os.path.join(dn, "test{0}".format(fn))
 def parseOptionString(s):
     """
     Function used to convert an option string into a list of options.
     @param s option string (string or string)
     @return list of options (list of strings)
     """
     rx = QRegExp(r"""\s([\w=/-]*"[^"]+"|[\w=/-]*'[^']+'|[^\s]+)""")
     s = re.sub(r"%[A-Z%]", _percentReplacementFunc, s)
     return parseString(s, rx)
 def parseEnvironmentString(s):
     """
     Function used to convert an environment string into a list of environment
     settings.
     @param s environment string (string)
     @return list of environment settings (list of strings)
     """
     rx = QRegExp(r"""\s(\w+\+?=[^\s]+|\w+="[^"]+"|\w+='[^']+')""")
     return parseString(s, rx)
 def parseString(s, rx):
     """
     Function used to convert a string into a list.
     @param s string to be parsed (string)
     @param rx regex defining the parse pattern (QRegExp)
     @return list of parsed data (list of strings)
     """
     olist = []
     if not s.startswith(' '):
         # prepare the  string to fit our pattern
         s = ' ' + s
     pos = rx.indexIn(s)
     while pos != -1:
         cs = rx.cap(1)
         if cs.startswith('"') or cs.startswith("'"):
             cs = cs[1:-1]
         olist.append(cs)
         pos += rx.matchedLength()
         pos = rx.indexIn(s, pos)
     return olist
 def _percentReplacementFunc(matchobj):
     """
     Protected function called for replacing % codes.
     @param matchobj matchobject for the code
     @return replacement string
     """
     return getPercentReplacement(matchobj.group(0))
 def getPercentReplacement(code):
     """
     Function to get the replacement for code.
     @param code code indicator (string)
     @return replacement string (string)
     """
     if code in ["C", "%C"]:
         # column of the cursor of the current editor
         aw = e5App().getObject("ViewManager").activeWindow()
         if aw is None:
             column = -1
         else:
             column = aw.getCursorPosition()[1]
         return "{0:d}".format(column)
     elif code in ["D", "%D"]:
         # directory of active editor
         aw = e5App().getObject("ViewManager").activeWindow()
         if aw is None:
             dn = "not_available"
         else:
             fn = aw.getFileName()
             if fn is None:
                 dn = "not_available"
             else:
                 dn = os.path.dirname(fn)
         return dn
     elif code in ["F", "%F&