summaryrefslogtreecommitdiff
path: root/gerber/__init__.py
blob: 31973359292f92785ef143943bc44d3e4931c3b8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
#! /usr/bin/env python
# -*- coding: utf-8 -*-

# Copyright 2013-2014 Paulo Henrique Silva <ph.silva@gmail.com>

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

#     http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
gerber module
============
**Gerber Tools**

"""

def read(filename):
    """ Read a gerber or excellon file and return a representative object.

    Parameters
    ----------
    filename : string
        Filename of the file to read.

    Returns
    -------
    file : CncFile subclass
        CncFile object representing the file, either GerberFile or
        ExcellonFile. Returns None if file is not an Excellon or Gerber file.
    """
    import gerber
    import excellon
    from utils import detect_file_format
    fmt = detect_file_format(filename)
    if fmt == 'rs274x':
        return gerber.read(filename)
    elif fmt == 'excellon':
        return excellon.read(filename)
    else:
        return None