Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

# Copyright (C) 2015 Chintalagiri Shashank 

# 

# This file is part of Tendril. 

# 

# This program is free software: you can redistribute it and/or modify 

# it under the terms of the GNU Affero General Public License as published by 

# the Free Software Foundation, either version 3 of the License, or 

# (at your option) any later version. 

# 

# This program is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 

# GNU Affero General Public License for more details. 

# 

# You should have received a copy of the GNU Affero General Public License 

# along with this program.  If not, see <http://www.gnu.org/licenses/>. 

""" 

Indent Dox Module (:mod:`tendril.dox.indent`) 

============================================= 

 

This module provides functions to generate stock / inventory indents. 

 

The functions here use the :mod:`tendril.dox.render` module to actually 

produce the output files after constructing the appropriate stage. 

 

.. seealso:: :mod:`tendril.dox` 

 

.. rubric:: Document Generators 

 

.. autosummary:: 

 

    gen_stock_idt_from_cobom 

 

 

""" 

 

import render 

import os 

 

import docstore 

import labelmaker 

 

from tendril.entityhub import serialnos 

from tendril.utils.db import with_db 

from tendril.boms.outputbase import load_cobom_from_file 

 

 

def gen_stock_idt_from_cobom(outfolder, sno, title, carddict, cobom): 

    """ 

    Generates a stock indent from a 

    :class:`tendril.boms.outputbase.CompositeOutputBom` instance. This 

    function also adds ``IDT`` labels for all the stock / inventory items that 

    are requested for by the indent to the 

    :data:`tendril.dox.labelmaker.manager`, though the caller should make sure 

    that the labels are written out after the fact. 

 

    .. note:: 

        This function does not register the document in the 

        :mod:`tendril.dox.docstore`. You should use the output file path 

        (returned by this function) to register the document when desired. 

 

    :param outfolder: The folder within which the output PDF should 

                      be created. 

    :type outfolder: str 

    :param sno: The serial number of the Indent 

    :type sno: str 

    :param title: The title of the Indent 

    :param carddict: A dictionary containing the list of card types included 

                     for the indent (keys) and the quantity for each (values). 

    :type carddict: dict 

    :param cobom: The composite output BOM, including the BOMs for the cards 

                  that the indent is being constructed for. 

    :type cobom: :class:`tendril.boms.outputbase.CompositeOutputBom` 

    :return: The output file path. 

 

    .. rubric:: Template Used 

 

    ``tendril\dox\\templates\indent_stock_template.tex`` 

    (:download:`Included version 

    <../../tendril/dox/templates/indent_stock_template.tex>`) 

 

    .. rubric:: Stage Keys Provided 

    .. list-table:: 

 

        * - ``sno`` 

          - The serial number of the indent. 

        * - ``title`` 

          - Whether the device is a PCB or a Cable. 

        * - ``lines`` 

          - List of dictionaries, each containing the ``ident`` and ``qty`` 

            of one line in the indent. 

        * - ``cards`` 

          - A string listing out the various cards the indent was generated 

            to request components for. 

 

    """ 

    outpath = os.path.join(outfolder, str(sno) + '.pdf') 

    cards = "" 

    for card, qty in sorted(carddict.iteritems()): 

        cards += card + ' x' + str(qty) + ', ' 

 

    indentsno = sno 

 

    lines = [] 

    for idx, line in enumerate(cobom.lines): 

        lines.append({'ident': line.ident, 'qty': line.quantity}) 

        labelmaker.manager.add_label( 

            'IDT', line.ident, indentsno + '.' + str(idx), qty=line.quantity) 

 

    stage = {'title': title, 

             'sno': indentsno, 

             'lines': lines, 

             'cards': cards} 

 

    template = 'indent_stock_template.tex' 

    render.render_pdf(stage, template, outpath) 

 

    return outpath, indentsno 

 

 

def get_all_indents(limit=None): 

    return docstore.get_docs_list_for_sno_doctype( 

        serialno=None, doctype='INVENTORY INDENT', limit=limit 

    ) 

 

 

def get_indent_docs(serialno=None): 

    rval = [] 

    rval.extend(docstore.get_docs_list_for_serialno(serialno=serialno)) 

    return rval 

 

 

@with_db 

def get_indent_production_order(serialno=None, session=None): 

    parents = serialnos.get_parent_serialnos(sno=serialno, session=session) 

    prod_sno = None 

    for parent in parents: 

        # TODO fix this 

        if parent.parent.sno.startswith('PROD'): 

            prod_sno = parent.parent.sno 

            break 

    if not prod_sno: 

        return None 

    return prod_sno 

 

 

def get_indent_cobom(serialno=None): 

    try: 

        cobom_path = docstore.get_docs_list_for_sno_doctype( 

            serialno=serialno, doctype='PRODUCTION COBOM CSV' 

        )[0].path 

    except IndexError: 

        return None 

    with docstore.docstore_fs.open(cobom_path, 'r') as f: 

        cobom = load_cobom_from_file( 

            f, os.path.splitext(os.path.split(cobom_path)[1])[0] 

        ) 

    return cobom